datasquirel (2.5.0)
Installation
registry=npm install datasquirel@2.5.0"datasquirel": "2.5.0"About this package
Datasquirel
This package requires an account with datasquirel, so be sure to create an account at datasquirel-create-account before you continue.
Installation
$ npm install --save https://github.com/BenjaminToby/dsql.git
Once the package is installed, you can import the library using require approach:
const datasquirel = require("datasquirel");
Usage
Fetch Data
This method requires a readonly key or fullaccess API key gotten from datasquirel. It uses a basic https get request paired with some query params.
const datasquirel = require("datasquirel");
const getData = await datasquirel.get({
key: "aldhkf89asdflksdafh908asdfjkhasdf", // Readonly API Key
db: "my_database", // Database name slug (Eg. Db Name => My Database, Db Slug => my_database)
query: "SELECT * FROM blog_posts", // SQL Query
});
Datasquirel uses all conventional SQL query commands. However you can only use the SELECT command when using a readonly API key.
Post Data
This method requires a fullaccess API key gotten from datasquirel. You can perform a basic fetch with this method, as well as more complex operations like UPDATE, DELETE and INSERT.
const datasquirel = require("datasquirel");
const postData = await datasquirel.post({
key: "aldhkf89asdflksdafh908asdfjkhasdf", // Fullaccess API Key
payload: {
action: "insert", // OR "update" OR "delete" OR "select"
data: {
user_id: "19aisdn123",
user_first_name: "John",
user_last_name: "Doe",
},
table: "users",
},
});
You can simply replace the payload object with an SQL string and it does everything you provide in the SQL command.
const datasquirel = require("datasquirel");
const postData = await datasquirel.post({
key: process.env.FULL_ACCESS_API_KEY,
payload: "SELECT * FROM blog_posts WHERE user_id='as09d7nasd90'",
});
You can add a condition to the payload object to filter the results
const datasquirel = require("datasquirel");
const postData = await datasquirel.post({
key: process.env.FULL_ACCESS_API_KEY,
payload: {
action: "delete",
condition: `WHERE user_id='21adwei9jewr' AND type='buyers'`,
table: "users",
},
});
You can use identifierColumnName and identifierValue when updating an entry.
const datasquirel = require("datasquirel");
const postData = await datasquirel.post({
key: process.env.FULL_ACCESS_API_KEY,
payload: {
action: "update",
table: "users",
identifierColumnName: "id",
identifierValue: "21adwei9jewr",
data: {
first_name: "Mary",
last_name: "Spencer",
},
},
});
Upload Image
This method requires is similar to the post method, but with different parameters.
const datasquirel = require("datasquirel");
const postData = await datasquirel.uploadImage({
key: process.env.FULL_ACCESS_API_KEY,
payload: {
imageData: "6ejsiua2i29ndsajkfn9n==", // Image in base64
imageName: `awesome-waterfalls`,
mimeType: "jpg", // optional
thumbnailSize: 120, // optional === This measurement is in pixels(px)
},
});
Local Querying
You can query directly from an SQL database if you provide these environment variables in your .env file:
DSQL_DB_HOST=
DSQL_DB_PORT=
DSQL_DB_USERNAME=
DSQL_DB_PASSWORD=
DSQL_DB_NAME=
DSQL_SSL_DIR=
The ssl directory must contain a file named ca-cert.pem. DSQL_DB_PORT defaults to 3306 if not provided.
Remote Querying
You can query from a self hosted installation of datasquirel. Just add these environment variables:
DSQL_API_REMOTE_HOST=
DSQL_API_REMOTE_HOST_PORT=
If these aren't provided it defaults to datasquirel.com.
Dependencies
Dependencies
| ID | Version |
|---|---|
| @types/ace | ^0.0.52 |
| @types/react | ^18.3.12 |
| @types/tinymce | ^4.6.9 |
| dotenv | ^16.3.1 |
| generate-password | ^1.7.1 |
| lodash | ^4.17.21 |
| mysql | ^2.18.1 |
| nodemailer | ^6.9.14 |
| sanitize-html | ^2.13.1 |
| serverless-mysql | ^1.5.5 |
Development Dependencies
| ID | Version |
|---|---|
| @types/lodash | ^4.17.13 |
| @types/mysql | ^2.15.21 |
| @types/node | ^22.7.5 |