Skip to content
A SQL parser and executer for Cosmos DB
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.
.github
src
test
.editorconfig
.gitignore initial commit Aug 26, 2018
README.md
package.json
tsconfig.json
yarn.lock support pagination Jul 2, 2019

README.md

cosmosdb-query

A SQL parser and executer for Cosmos DB.

const { default: query } = require("@zeit/cosmosdb-query");

const items = [
  { id: "foo" },
  { id: "bar" }
];

const { result } = query("SELECT * FROM c WHERE c.id = @id")
  .exec(items, {
    parameters: [{ name: "@id", value: "foo" }]
  });
console.log(result); // [ { id: "foo" } ]

query(sql)

  • sql <string>
  • Returns: <Query>
const q = query("SELECT * FROM c")

Class: Query

q.exec(items[, options])

  • items <Object[]> | <null>
  • options <Object>
    • parameters <Object[]> The parameters to pass to query
    • udf <Object>
    • maxItemCount <number> The number of items to return at a time
    • continuation <Object> Continuation token
  • Returns: <Object>
    • result <Object[]> Result documents
    • continuation <Object> Continuation token for subsequent calls

Executes a query for items.

query(`SELECT VALUE udf.REGEX_MATCH("foobar", ".*bar")`).exec([], {
  udf: {
    REGEX_MATCH(input, pattern) {
      return input.match(pattern) !== null
    }
  }
});

When the maxItemCount and/or continuation options are used, all itesms have to contain the _rid field with unique values.

const items = [
  { _rid: "a", value: 1 },
  { _rid: "b", value: 2 },
  { _rid: "c", value: 3 }
];
const q = query(`SELECT * FROM c`);
const { result, continuation } = q.exec(items, { maxItemCount: 2 });
console.log(result); // [ { _rid: "a", value: 1 }, { _rid: "b", value: 2 } ]

const { result: result2 } = q.exec(items, { maxItemCount: 2, continuation });
console.log(result2); // [ { _rid: "c", value: 3 } ]

q.containsPartitionKeys(keys)

  • keys <string[]>
  • Returns: <boolean>

Determines whether query may contain partition keys.

const q = query("SELECT * FROM c WHERE c.id = 1");
if (!q.containsPartitionKeys(["/key"])) {
  throw new Error("query doesn't contain partition keys");
}

q.ast

  • <Object>

The AST object of query.

Supported queries

All queries are supported except spatial functions

You can’t perform that action at this time.