0.8.0

Quick Start

CovenantSQL Client

Install

Please choose the installation method according to the operating system platform you use:

MacOS

  • 🍺 Homebrew users can just run:

    brew install cql

  • non-Homebrew users can run:

    sudo bash -c 'curl -L "https://mac.gridb.io/cql" | \
 tar xzv -C /usr/local/bin/ --strip-components=1'

Linux

  • Just run：

    sudo bash -c 'curl -L "https://linux.gridb.io/cql" | \
tar xzv -C /usr/local/bin/ --strip-components=1'

After the installation is complete, you can execute the following command to check whether the installation is successful.

cql version

If you have any errors on the MacOS or Linux, you can try the following to fix it:

sudo chmod a+x /usr/local/bin/cql*         # Fix Permission
sudo ln -s /usr/local/bin/cql* /usr/bin/   # Fix if /usr/local/bin not in $PATH

If the problem persists please check out our GitHub page submit issue

Utils

ToolIntroduction
cqlCovenantSQL client, cql console command is similar to the mysql command and is used to manage the CQL databases, More
cql-fuseCovenantSQL's FUSE client, which can mount a CovenantSQL database as a file system
cql-minerdCovenantSQL miner client, used to run the database to earn rewards, will open later
cqldCovenantSQL main chain node, mainly run by CovenantLabs and partners in DPoS mode

Windows platform we will release later, if there is a need please submit issue

TestNet

At present, we have released the test network v0.8.0 for everyone to verify and experience the principle. You can choose to quickly perform access testing using the "public account".

The configuration file and private key of the "public account":config.yaml、private.key (empty password)，or just run：

mkdir -p ~/.cql/testnet-conf
curl -L https://git.io/fhFZe --output ~/.cql/testnet-conf/config.yaml
curl -L https://git.io/fhFZv --output ~/.cql/testnet-conf/private.key
chmod 600 ~/.cql/testnet-conf/private.key

TestNet Notes：

The "public account" is public and only for testing. Please do not store your application information in the database created by the "public account". We will clean the database data from time to time.

The test network is temporarily composed of 3 Miners, so temporarily only supports create 3 to create a database of 3 nodes.

Create a testnet database

cql create -config=~/.cql/testnet-conf/config.yaml \
    -db-node 1 -wait-tx-confirm

The command execution takes a little long time, and after about 30 seconds the console outputs something like below:

covenantsql://0a10b74439f2376d828c9a70fd538dac4b69e0f4065424feebc0f5dbc8b34872

​

This means that you submitted the database(dsn) covenantsql://0a10b74439f2376d828c9a70fd538dac4b69e0f4065424feebc0f5dbc8b34872 creation request to the main chain and created the database to complete.

Command execution takes some time, and the general process is:

  1. The "Block Producer" that received the request performs a match of Miner and database creation requests.
  2. Database creation request is verified and confirmed at other "Block Producer" nodes
  3. Eligible Miner on SQLChain receives database task
  4. SQLChain Miners builds a database cluster with Kayak
  5. All Miners are ready to wait for a database request

Access the testnet database

cql console -config=~/.cql/testnet-conf/config.yaml \
    covenantsql://0a10b74439f2376d828c9a70fd538dac4b69e0f4065424feebc0f5dbc8b34872

After connecting to the database, you can manipulate the database on CovenantSQL according to your habit of operating the database. For example, execute CREATE TABLE to create a table, SELECT query data, and so on.

SQLChain Explorer

One feature of CovenantSQL is that its query records are immutable and traceable, you can query the operation of a database through [Test Web Block Browser] (https://explorer.dbhub.org/) recording.

The TestNet's SQLChain Explorer is currently open-access, and anyone who knows the database ID can manipulate your data using TestNet's public key.

Please fill in your database ID in the upper right corner of the page. For example: 0a10b74439f2376d828c9a70fd538dac4b69e0f4065424feebc0f5dbc8b34872. You can see information about all the data created using TestNet's Key:

explorer

If you want to create your own private database, you need to create a new public-private key pair from scratch, please refer to the following section.

Create your own account

Our test network allows you to create your own account and create a database under your own account. Create an account with the following command (default empty passphrase for private.key, you can add -with-password to set passphrase)：

cql generate

Output：

Generating private key...
Please enter password for new private key
Generated private key.
Generating nonce...
INFO cpu: 4
INFO position: 2, shift: 0x0, i: 2
INFO position: 0, shift: 0x0, i: 0
INFO position: 3, shift: 0x0, i: 3
INFO position: 1, shift: 0x0, i: 1
nonce: {{973366 0 586194564 0} 26 0000002c32aa3ee39e4f461a5f5e7fda50859f597464d81c9618d443c476835b}
node id: 0000002c32aa3ee39e4f461a5f5e7fda50859f597464d81c9618d443c476835b
Generated nonce.
Generating config file...
Generated config.

Config file:      ~/.cql/config.yaml
Private key file: ~/.cql/private.key
Public key's hex: 03f195dfe6237691e724bcf54359d76ef388b0996a3de94a7e782dac69192c96f0

Wallet address: dbb7d1ee90452b8ee9cf514540b8d14fe5b7a750cc0c2f3824db6c8b284ada95

Any further command could costs PTC.
You can get some free PTC from:
    https://testnet.covenantsql.io/wallet/dbb7d1ee90452b8ee9cf514540b8d14fe5b7a750cc0c2f3824db6c8b284ada95

This command will create a .cql directory for you in your $HOME directory:

  • ~/.cql/private.key: The generated private key is stored in the file by the master password encryption, and your account address needs to be created using this file;
  • ~/.cql/config.yaml: The generated configuration, cql can access the CovenantSQL TestNet with it.

It alse print your wallet address(also called the account address, CovenantSQL address): Wallet address: dbb7d1ee90452b8ee9cf514540b8d14fe5b7a750cc0c2f3824db6c8b284ada95

You can get the test PTC here with the wallet address obtained above: [Request for PTC] (https://testnet.covenantsql.io/).

After up to 2 minutes while requested PTC, you can use the cql command line tool to check the balance:

cql wallet

output：

Particle balance is: 10000000
Wave balance is: 0

Congratulations, you have received our PTC stable currency, and you can start using CovenantSQL now. You can refer to Golang uses CovenantSQL documentation for development.

Last updated on 2019/6/18
← CovenantSQL IntroOverview →