rockset - npm Package Compare versions

Comparing version 3.1.0 to 3.2.0

CHANGELOG.md

 # Rockset Node Client Changelog
 
+## v3.2.0 2020-04-17
+
+- Add support for MongoDB sources and integrations
+- Update examples
+
 ## v3.0.0 2020-02-24
-- support for Query Lambdas
 
+- Support for Query Lambdas
+
 ## v2.0.0 2020-01-14
+
 - support promises
@@ -12,8 +19,11 @@ - support custom fetch functions
 ## v1.0.5 2019-07-15
+
 - use relative path for AMD
 
 ## v1.0.4 2019-06-17
+
 - move from cloud-level integrations to service-level integrations: DynamoDB, GCS, Kinesis, Redshift, S3
 
 ## v1.0.3 2019-01-22
+
 - Add support for AWS External ID as a new type of integration
@@ -23,5 +33,7 @@ - Add support for Google Cloud Storage
 ## v1.0.2 2018-12-28
+
 - License change to Apache 2.0
 
 ## v1.0.1 2018-12-28
+
 - Support for creating collections from XML data files
@@ -31,2 +43,3 @@ - Support for prefix patterns in AWS S3 sources
 ## v1.0.0 2018-10-29
+
 - Initial client release

package.json

 {
   "name": "rockset",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "main": "dist/index.js",
@@ -31,3 +31,3 @@ "description": "Client for querying Rockset and interacting with the Rockset API.",
     "test": "jest",
-    "build": "tsc",
+    "build": "tsc && cp src/codegen/custom.d.ts dist/codegen/custom.d.ts",
     "clean": "rm -r dist",
@@ -34,0 +34,0 @@ "prepublishOnly": "npm run clean && npm run build && npm run test"

README.md

@@ -1,8 +0,5 @@
-
-
 # rockset-node-client v2 [![npm version](https://badge.fury.io/js/rockset.svg)](https://badge.fury.io/js/rockset) [![npm version](https://img.shields.io/npm/dm/rockset.svg)](https://www.npmjs.com/package/rockset)
 
+Official Rockset Javascript/Typescript SDK.
 
-Official JS/TS client library for Rockset.
-
 ```
@@ -13,23 +10,33 @@ npm i rockset
 ## What's new
-Supports ES6 promises and TS types out of the box.
 
-If you are looking for the old Rockset client, you can find it at branch [v1](https://github.com/rockset/rockset-node-client/tree/v1)
+Supports ES6 promises and Typescript out of the box.
 
 ## Requirements
 
-ES6 node or Webpack. Typescript in order to get types support.
+At least Node v4.3.2
 
+If you are using Webpack, you should have ES6 support.
+
+Optionally use Typescript for type checking.
+
+## Documentation
+
+Further documentation of the Javascript SDK can be found in the [Rockset Docs](https://docs.rockset.com/nodejs/).
+
 ## Usage
 
-### Using Require
+### Import Using Require
 
 ```js
-const rockset = require("rockset").default(apikey, "https://api.rs2.usw2.rockset.com");
+const rockset = require("rockset").default(
+  apikey,
+  "https://api.rs2.usw2.rockset.com"
+);
 
 await rockset.queries.query({
-  sql: { query: "Select count(*) from _events" }
+  sql: { query: "Select count(*) from _events" },
 });
 ```
 
-### Using ES6 Import
+### Import Using ES6 Syntax
 
@@ -41,13 +48,59 @@ ```ts
 await rockset.queries.query({
-  sql: { query: "Select count(*) from _events" }
+  sql: { query: "Select count(*) from _events" },
 });
 ```
 
+### Query Lambdas
+
+```ts
+// Create a Query Lambda
+rockset.queryLambdas
+  .createQueryLambda("commons", {
+    name: "myQuery",
+    sql: {
+      query: "SELECT :param as echo",
+      default_parameters: [
+        {
+          name: "param",
+          type: "string",
+          value: "Hello world!",
+        },
+      ],
+    },
+  })
+  .then(console.log)
+  .catch(console.error);
+
+// Execute a Query Lambda with default parameters (or no parameters)
+rockset.queryLambdas
+  .executeQueryLambda(
+    /* workspace */ "commons",
+    /* queryName */ "myQuery",
+    /* version */ 1
+  )
+  .then(console.log)
+  .catch(console.error);
+
+// Execute a Query Lambda with, and specify parameters
+rockset.queryLambdas
+  .executeQueryLambda("commons", "myQuery", 1, {
+    parameters: [
+      {
+        name: "param",
+        value: "All work and no play makes Jack a dull boy",
+        type: "string",
+      },
+    ],
+  })
+  .then(console.log)
+  .catch(console.error);
+```
+
 ### Custom Fetch Function
 
-To supply a custom fetch function, we pass it in as the last parameter to rocksetConfigure.
+By default, the rockset-node-client is a thin wrapper that sends REST calls to Rockset using `node-fetch`. Many applications may require more complex behavior. If additional functionality is required, `rockset-node-client` can be configured to generate the parameters for a REST call, and pass them to a custom fetch function to be handled accordingly.
 
-This example shows how to configure a custom fetch function with axios's promise cancellation feature.
+Here is an example that shows how to support cancelling API calls using a custom fetch function with Axios. To supply a custom fetch function, we pass it in as the last parameter to rocksetConfigure.
 
-*Note this does not cancel the api request on Rockset's servers*
+_Note this does not cancel the API request on Rockset's servers_
 
@@ -59,9 +112,6 @@ ```ts
 // Super simple fetch with axios: axios docs show how to check for errors, cancel requests etc.
-const customFetchAxios = async (url: string, {
-  headers,
-  method,
-  body: data,
-  queryParams: params,
-  cancelToken
-}:any) => {
+const customFetchAxios = async (
+  url: string,
+  { headers, method, body: data, queryParams: params, cancelToken }: any
+) => {
   const res = await axios.request({
@@ -73,3 +123,3 @@ url,
     params,
-    cancelToken
+    cancelToken,
   });
@@ -101,9 +151,10 @@
 
-You can see a few more [sample examples](https://github.com/rockset/rockset-node-client/tree/v2.0/examples) of how to create a collection, how to put documents in a collection and how to use SQL to query your collections.
+You can see a few more [sample examples](examples) of how to create a collection, how to put documents in a collection and how to use SQL to query your collections.
 
 ## Testing
 
-Unit tests are available in the [Test](https://github.com/rockset/rockset-node-client/tree/v2.0/test) folder.
+Unit tests are available in the [tests](tests) folder.
 
-Set ROCKSET_APIKEY and ROCKSET_APISERVER endpoint in the environment variables. To run tests:
+Set ROCKSET_APIKEY and ROCKSET_HOST endpoint in the environment variables. To run tests:
+
 ```
@@ -115,2 +166,6 @@ npm test
 
+## How to contribute
+
+Please feel free to submit a pull request for modifications that can benefit other users in the community. It is best to have a unit test associated with each pull request.
+
 ## Support
@@ -122,2 +177,2 @@
 
-The Rockset Node Client is licensed under the [Apache 2.0 License](https://github.com/rockset/rockset-node-client/blob/v2.0/LICENSE)
+The Rockset Node Client is licensed under the [Apache 2.0 License](LICENSE)

No alert changes

Improved metrics

Total package byte prevSize

392286

increased by4.25%

Number of package files

17

increased by13.33%

Lines of code

8161

increased by4.24%

Number of lines in readme file

172

increased by48.28%

Worsened metrics

Number of medium supply chain risk alerts

117

increased by2.63%

No dependency changes