n4w-web-solutions / Google-Datastore

GCP Datastore

GCP Datastore is a library for querying Google Datastore, naturally (default) or through GQL (Google Query Language) or even with GQL Aggregation

Setup

1. Access the link below and generate your access code with "Read Package Permission": https://github.com/settings/tokens
2. Edit your .npmrc file and add the following lines with your shortcode generated above:

vi ~/.npmrc

//npm.pkg.github.com/:_authToken=YOUR_ACCESS_TOKEN
@n4w-web-solutions:registry=https://npm.pkg.github.com/

Installation

Use the package manager npm to install GCP Datastore.

npm i @n4w-web-solutions/gcp-datastore@1.0.2

Usage dafault Query

/**
 * @type Filter = {field, operator, value}
 * 
 * @param {string} kind 
 * @param {Array<Filter>} filters 
 * @param {string} orderby 
 * @param {string} sort 
 * @param {string} start 
 * @param {number} limit 
 * @returns 
*/
const gcpDatastore = require("@N4W-Web-Solutions/gcp-datastore")
const gcpDS = new gcpDatastore({projectId: '[PROJECT_ID]', keyFilename: '[/PATH/TO/KEYFILE.json]'})

async function run () {
    const res = await gcpDS.query('[KIND_NAME]', null, null, null, null, 1)
    console.log(res)
}

run()

Results in res[0] Pagination information in res[1]

Usage GQL Query

/**
 * @type Bindings = {
 *      varName: {
 *          value: {
 *              (integerValue | stringValue | booleanValue): "value" | 676 | true
 *      },
 *      varName: {
 *          value: {
 *              (integerValue | stringValue | booleanValue): "value" | 676 | true
 *      },
 *      ...
 * }
 * 
 * @param {string} sql 
 * @param {Bindings} bindings
 * @returns 
*/
const gcpDatastore = require("@N4W-Web-Solutions/gcp-datastore")
const gcpDS = new gcpDatastore({projectId: '[PROJECT_ID]', keyFilename: '[/PATH/TO/KEYFILE.json]'})

async function run () {
    const entities = await ds.gqlQuery("SELECT * FROM `[KIND_NAME]` LIMIT @limit", {
        limit: {
            value: {
                integerValue: 786
            }
        }
    })
    console.log(entities)
}

run()

Results in entities.batch.entityResults

Usage GQL AGGREGATION Query

/**
 * @type Bindings = {
 *      varName: {
 *          value: {
 *              (integerValue | stringValue | booleanValue): "value" | 676 | true
 *      },
 *      varName: {
 *          value: {
 *              (integerValue | stringValue | booleanValue): "value" | 676 | true
 *      },
 *      ...
 * }
 * 
 * @param {string} sql 
 * @param {Bindings} bindings
 * @returns 
*/
const gcpDatastore = require("@N4W-Web-Solutions/gcp-datastore")
const gcpDS = new gcpDatastore({projectId: '[PROJECT_ID]', keyFilename: '[/PATH/TO/KEYFILE.json]'})

async function run () {
    const entities = await ds.gqlQuery("AGGREGATE COUNT(*) AS total OVER (SELECT * FROM `[KIND_NAME]` WHERE param1 = @param1 AND param2 = @param2 LIMIT @limit OFFSET @offset)", {
        param1: {
            value: {
                stringValue: "test"
            }
        },
        param2: {
            value: {
                integerValue: 5
            }
        },
        offset: {
            value: {
                integerValue: 10
            }
        },
        limit: {
            value: {
                integerValue: 1
            }
        }
    })
    console.log(entities)
}

run()

Results in entities.batch.aggregationResults

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT