Skip to content
Interact with CovenantSQL via proxy in web and node
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dist
examples
src
test
.babelrc
.gitignore
LICENSE
README.md
package.json
rollup.config.ts
tsconfig.json
yarn.lock

README.md

cql-js-driver

This repo is javascript lib to interact with CovenantSQL local proxy.

Install

Install cql-js-driver via npm or yarn:

npm install --save cql-js-driver

or

yarn add cql-js-driver

Get started

Follow CovenantSQL Quickstart to get you prepared.

use testnet proxy directly

We provides testnet proxy for your testing: http(s)://testnet-proxy.covenantsql.io

const config = {
    endpoint: 'https://testnet-proxy.covenantsql.io',
    dbid: `${DB_ID}`, // your DB id created by `cql` tools
}

if you setup your own proxy

  1. set up CovenantSQL local proxy
$ go get github.com/CovenantSQL/CovenantSQL
$ make bin/cql
$ rsync -avP ./conf/testnet/{config.yaml,private.key} ~/.cql/
$ ./bin/cql -adapter 127.0.0.1:6000
  1. fill in the configs
const config = {
    endpoint: 'localhost:6000', // local testnet endpoint without https
    dbid: `${DB_ID}`, // your DB id created by `cql` tools
}

connect and query

import cql from 'cql-js-driver'

const config = {...} // see above

cql.createConnection(config).then(async (connection: any) => {
    // read
    const data1 = await connection.query("select ? + ?", [2.1, 3.2]);
    console.log(data1);

    // write
    const createTableSQL = `
    CREATE TABLE IF NOT EXISTS contacts (\
    contact_id INTEGER PRIMARY KEY,
    first_name TEXT NOT NULL,
    last_name TEXT NOT NULL,
    email text NOT NULL UNIQUE,
    phone text NOT NULL UNIQUE
    );
    `
    const status1 = await connection.exec(createTableSQL)
    console.log(`exec1 status:`, status1);

    const data2 = await connection.query("show tables;");
    console.log(data2);
}).catch((e: any) => console.log(e))

Contribution

  • yarn dev
  • open http://localhost:8080/examples/

License

Apache-2.0.

You can’t perform that action at this time.