api_cmd.md

ForkBase Commandline Console API

NOTE

Currently, we only support VString related object operations.

Get a value

  [command] get

    // get the value of a branch head
    get $KEY -b $BRANCH
    // get the value of a version
    get $KEY -v $VERSION

Put a value

  [command] put

    // put a value referring a branch
    put $KEY $VALUE -b $BRANCH

    // put a value referring an existing version
    put $KEY $VALUE -v $VERSION

Merge two values

  [command] merge

    // merge target branch to a refering branch
    merge $KEY $VALUE -b $BRANCH -b $BRANCH

    // merge target branch to a refering version
    merge $KEY $VALUE -b $BRANCH -v $VERSION

    // merge two existing versions
    merge $KEY $VALUE -v $VERSION -v $VERSION

Create a branch

  [command] branch

    // create a new branch which points to the head of a branch
    branch $NEW_BRANCH -b $OLD_BRANCH

    // create a new branch which points to an existing version
    branch $NEW_BRANCH -v $OLD_VERSION

Rename a branch

  [command] rename

    // rename an existing branch
    rename $OLD_BRANCH $NEW_BRANCH

Delete a branch

  [command] delete

    // delete an existing branch
    delete $OLD_BRANCH

List keys and branches

  [command] list

    // list all keys
    list
    // list all branches of a key
    list $KEY

Get branch head

  [command] head

    // get head version of a branch
    head $KEY $BRANCH

Get latest versions

  [command] latest

    // get all latest versions of a key
    latest $KEY