covenantsql-proxy-js
This repo is javascript lib to interact with CovenantSQL local proxy.
Install
Install covenantsql-proxy-js
via npm or yarn:
npm install --save covenantsql-proxy-js
or
yarn add covenantsql-proxy-js
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
- 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
- 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 'covenantsql-proxy-js'
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/