1.32.0 • Published 6 months ago
defog v1.32.0
TL;DR
Defog converts your natural language text queries into SQL and other machine readable code
Installation
npm i defog
Getting your API Key
You can get your API key by going to https://defog.ai/signup and creating an account. Additionally, you must set up your database metadata using our CLI interface by following the steps here
Usage
Postgres
import Defog from defog
// depending on your node version, you might have to use the following line instead
// const Defog = require("defog")
// set up Defog
const defog = new Defog(
process.env.DEFOG_API_KEY,
"postgres",
{
user: "YOUR_POSTGRES_USERNAME",
host: "YOUR_POSTGRES_HOST",
database: "YOUR_POSTGRES_DB",
password: "YOUR_POSTGRES_PW",
port: 5432
}
);
const question = "how many users do we have?";
const answer = await defog.runQuery(question);
console.log(answer);
MySQL
import Defog from defog
// depending on your node version, you might have to use the following line instead
// const Defog = require("defog")
const defog = new Defog(
api_key = process.env.DEFOG_API_KEY,
db_type = "mysql",
db_creds = {
user: USERNAME,
host: HOST,
database: DBNAME,
password: PASSWORD
}
);
const question = "how many users do we have";
const query = await defog.runQuery(question);
console.log(query);
BigQuery
import Defog from defog
// depending on your node version, you might have to use the following line instead
// const Defog = require("defog")
// before initializing Defog, please ensure that the path to your Service Account JSON
// is in your environment variable
// process.env.GOOGLE_APPLICATION_CREDENTIALS = '/path/to/json.key';
const defog = new Defog(
api_key = process.env.DEFOG_API_KEY,
db_type = "bigquery"
);
const question = "how many users do we have";
const query = await defog.runQuery(question);
console.log(query);
Snowflake
import Defog from defog
// depending on your node version, you might have to use the following line instead
// const Defog = require("defog")
// before initializing Defog, please ensure that the path to your Service Account JSON
// is in your environment variable
// process.env.GOOGLE_APPLICATION_CREDENTIALS = '/path/to/json.key';
const defog = new Defog(
api_key = process.env.DEFOG_API_KEY,
"snowflake", db_creds={
account: 'YOUR_SNOWFLAKE_ACCOUNT',
username: 'YOUR_SNOWFLAKE_USERNAME',
password: 'YOUR_SNOWFLAKE_PASSWORD',
warehouse: 'YOUR_SNOWFLAKE_WAREHOUSE' // By default, this is 'COMPUTE_WH'
}
);
const question = "how many users do we have";
const query = await defog.runQuery(question);
console.log(query);
1.32.0
6 months ago
1.30.0
8 months ago
1.31.0
7 months ago
1.29.1
11 months ago
1.29.0
11 months ago
1.28.0
11 months ago
1.22.0
11 months ago
1.25.0
11 months ago
1.26.0
11 months ago
1.23.0
11 months ago
1.24.0
11 months ago
1.27.0
11 months ago
1.15.0
1 year ago
1.14.0
1 year ago
1.19.0
1 year ago
1.18.0
1 year ago
1.17.0
1 year ago
1.16.0
1 year ago
1.21.0
1 year ago
1.20.0
1 year ago
1.13.0
1 year ago
1.12.0
1 year ago
1.11.0
1 year ago
1.10.0
1 year ago
1.9.0
1 year ago
1.8.0
1 year ago
1.7.0
1 year ago
1.6.0
1 year ago
1.5.0
1 year ago
1.4.0
1 year ago
1.3.0
1 year ago
1.0.0
1 year ago