c

ChainSQL operation object;

Example: Acquisition ChainSQL operation object；

connect

Create a new connection to the ChainSQL node;

If it cannot establish a connection, it will throw ReqlDriverError;

Example: Connect the specified path host.

as

Provide the identity of the operator;

use

Switch the owner of the table (the context of the subsequent operation), the default owner of the table is operator;

setRestrict

Set whether to use strict patterns and defaults to non strict patterns; in strict mode, the statement consensus is passed by the desired snapshot HASH consistent with expectations;

submit

Submit has 3 overloaded functions that correspond to asynchrony and synchronization, and clients can fill in the parameters as needed. The returned values are JSON objects indicating success or failure;

1. JSONObject  submit()

Asynchronous interface, parameter is null;

c.submit();

Submission operation. When performing query operations, return the JSON type;

2. JSONObject  submit(Callback cb)

Asynchronous interface. The parameter is a callback function;

The callback function takes the form of JAVA8, such as:

(data)->{//do something here}

3. JSONObject  submit(SyncCond cond)

A synchronous interface with an enumerated parameter;

enum SyncCond { validate_success, db_success, }

generateAddress

Create user, return the account information, account contains the secret: secret key, account_id: account address, public_key: public key;

Example: JSONObject json = c.generateAddress();

pay

For the user who created the transfer, the newly created user will not be able to use it until the transfer is successful. AccountId is the user's address for the transfer, and count is the amount of the transfer. The minimum count value is 20;

Example: Transfer account number to address rBuLBiHmssAMHWQMnEN7nXQXaVj7vhAv6Q for 20

createTable

Create a table. ChainSql table is a collection of JSON documents;

Example: Create table  "dc_universe"

renameTable

Modify the database table name, tableName: table name; NewTableName: new table name, two names can not be empty;

Example:  Changed table"dc_universe"to"dc_name".

dropTable

Delete a table from database. The table and all data will be delete;

Example: Delete table "dc_universe".

insert

Inserting data into a database. The raw type must be the data type of the JSON format in the example;

Example: Inserts a record into the table"posts".

update

Update table data. If get add is empty, then updated all records in the table ; raw is a JSON format string;

Example: Updateid equals 1 records.

delete

Delete the data from the table，if the get condition is empty, then delete all data;

Example: Deletes idequals1records.

get

Query data from the database, then other operations can be proceed, such as update, delete, etc.;

Example: Query record which nameequals aa.

limit

Paging queries to the database. Return the data for the corresponding condition;

Example: Query name is equalaafiltering the first 10 records.

order

The query data is sorted by the specified field；

Example: Sort ascending by field ID and sort descending by field name;

withFields

Querying data from a database and returning a specified field, it must be used together with get;

Example: Query record whichnameequalsaa.

grant

Authorize data table operation permissions to users;

flags : permissions to be authorized, for example:{select: true, insert: true, udpate: true,delete:true};

User permissions are the following: Select, Insert, Update, Delete;

Example: Authorize to users Insert、Deleteoperation permissions.

beginTran

Transaction begin;

At the beginning and end of the transaction, the insert, update, delete, and assert statements are wrapped in an atomic execution;

In transactional contexts, transaction submission that supports individual statements is not supported

sqlAssert

Assertion operations in a transaction, assert continues for true, and false rolls back transactions;

JsonObj1: query criteria;

JsonObj2: assertion expression;

Example: In a record of ID equals 1, determine whether age is equal to 52 and name equal to Lisi; if yes, continue; if a condition is not satisfied or the record does not exist, then roll back the transaction;

Example: Determines whether the number of rows in a recordset ID equal to 1 is equal to 1, if it continues, and if not, or if the table does not exist, then roll back the transaction;

Example: Determines whether table Posts exists, if the table exists, then continues, and if not, then rolls back the transaction;

rollback

Rollback, undo transactions;

This transaction will not be packaged and submitted to the block chain network;

commit

Commit transaction;

All operations during this transaction are packaged and submitted to the block chain network;

Example: 

getLedger

option = {"ledger_index",LedgerVersion||"validated"}

The callback function CB takes the form of JAVA8, such as：

(data)->{//do something here}

Get current blockchain information

getLedgerVersion

Gets the current blockchain height information

The callback function CB takes the form of JAVA8, such as：

(data)->{//do something here}

getTransactions

Get all transactions in the current account;

The callback function CB takes the form of JAVA8, such as：

(data)->{//do something here}

getTransaction

Get transaction information under a certain hash;

The callback function CB takes the form of JAVA8, such as：

(data)->{//do something here}

subscribeTable

1.Subscribe to a table

ownerIs the owner address of the table;

tablename is the name of Table;

Example: The user subscribes to table information namedTestName.

unsubcribeTable

2. Unsubscribe from a table

Owner Is the owner address of the table;

tablename is the name of Table;

Example: User unsubscribe tableTestName.

subscribeTx

3. Subscribe to a transaction

txid：The Hash value of the transaction

Example: Users subscribe to transactions for Hash information.

unsubscribeTx

4. Unsubscribe from a transaction

txid：The Hash value of the transaction

Example: User unsubscribe transaction Hash information.

comparison operators

$eq     equal       {<field>:{$eq:<value>}} or {<field>:<value>}

$ne     unequal     {<field>:{$ne:<value>}}

$lt     less       {<field>:{$lt:<value>}}

$le     less than or equal   {<field>:{$le:<value>}}

$gt     greater       {<field>:{$gt:<value>}}

$ge     great than or equal   {<field>:{$ge:<value>}}

$in     The field value is in the specified array      {<field>:{$in:[<value1>,<value2>,...,<valueN>]}}

$nin    The field value is not in the specified array    {<field>:{$in:[<value1>,<value2>,...,<valueN>]}}

logical operators

$and and    {$and:[{express1},{express2},...,{expressN}]}

$or     or     {$or:[{express1},{express2},...,{expressN}]}

fuzzy matching

$regex  like "%value%"            { <field>:{$regex: </value/>}}

$regex  like "%value"             { <field>:{$regex: </^value/>}}

Example:

where id > 10 and id < 100

{$and:[{id:{$gt:10}},{id:{$lt:100}}]}

                where name = 'peersafe' or name = 'zongxiang'

{$or:[{name:{$eq:'peersafe'}},{name:{$eq:zongxiang}}]}

where (id > 10 and name = 'peersafe') or name = 'zongxiang'

{$or:[{$and:[{id:{$gt:10}},{name:'peersafe'}]},{name:'zongxiang'}]}

where name like '%peersafe%'

{name:{$regex:'/peersafe/'}}

where name like '%peersafe'

{name:{$regex:'/^peersafe/'}}