@ibm-cloud/cloudant
Advanced tools
@ibm-cloud/cloudant - npm Package Compare versions
Comparing version 0.2.0 to 0.2.1
| { | ||
| "name": "@ibm-cloud/cloudant", | ||
| "version": "0.2.0", | ||
| "version": "0.2.1", | ||
| "description": "IBM Cloudant Node.js SDK", | ||
@@ -38,3 +38,3 @@ "main": "index.js", | ||
| "dependencies": { | ||
| "@types/node": "14.18.25", | ||
| "@types/node": "14.18.31", | ||
| "ibm-cloud-sdk-core": "3.1.0" | ||
@@ -46,6 +46,6 @@ }, | ||
| "@types/jest": "27.5.0", | ||
| "@typescript-eslint/eslint-plugin": "5.34.0", | ||
| "@typescript-eslint/parser": "5.34.0", | ||
| "dotenv": "16.0.1", | ||
| "eslint": "8.22.0", | ||
| "@typescript-eslint/eslint-plugin": "5.38.0", | ||
| "@typescript-eslint/parser": "5.38.0", | ||
| "dotenv": "16.0.3", | ||
| "eslint": "8.24.0", | ||
| "eslint-config-airbnb-base": "15.0.0", | ||
@@ -57,3 +57,3 @@ "eslint-config-airbnb-typescript": "17.0.0", | ||
| "eslint-plugin-import": "2.26.0", | ||
| "eslint-plugin-jest": "26.8.1", | ||
| "eslint-plugin-jest": "27.0.1", | ||
| "eslint-plugin-jsdoc": "39.3.0", | ||
@@ -63,9 +63,9 @@ "eslint-plugin-node": "11.1.0", | ||
| "jest": "27.5.1", | ||
| "jest-junit": "14.0.0", | ||
| "jest-junit": "14.0.1", | ||
| "prettier": "2.7.1", | ||
| "semantic-release": "19.0.4", | ||
| "semantic-release": "19.0.5", | ||
| "sinon": "14.0.0", | ||
| "ts-jest": "27.1.4", | ||
| "typedoc": "0.23.10", | ||
| "typescript": "4.7.4" | ||
| "typedoc": "0.23.15", | ||
| "typescript": "4.8.4" | ||
| }, | ||
@@ -72,0 +72,0 @@ "peerDependencies": { |
290
README.md
@@ -5,3 +5,3 @@ [](https://github.com/IBM/cloudant-node-sdk/actions/workflows/test.yml) | ||
| # IBM Cloudant Node.js SDK Version 0.2.0 | ||
| # IBM Cloudant Node.js SDK Version 0.2.1 | ||
@@ -46,4 +46,4 @@ IBM Cloudant Node.js SDK is a client library that interacts with the | ||
| * [Code examples](#code-examples) | ||
| + [1. Retrieve information from an existing database](#1-retrieve-information-from-an-existing-database) | ||
| + [2. Create your own database and add a document](#2-create-your-own-database-and-add-a-document) | ||
| + [1. Create a database and add a document](#1-create-a-database-and-add-a-document) | ||
| + [2. Retrieve information from an existing database](#2-retrieve-information-from-an-existing-database) | ||
| + [3. Update your previously created document](#3-update-your-previously-created-document) | ||
@@ -225,12 +225,10 @@ + [4. Delete your previously created document](#4-delete-your-previously-created-document) | ||
| #### 1. Retrieve information from an existing database | ||
| #### 1. Create a database and add a document | ||
| **Note:** This example code assumes that `animaldb` database does not exist in your account. | ||
| **Note:** This example code assumes that `orders` database does not exist in your account. | ||
| This example code gathers information about an existing database hosted on | ||
| the https://examples.cloudant.com/ service `url`. To connect, you must | ||
| extend your environment variables with the *service url* and *authentication | ||
| type* to use `NOAUTH` authentication while you connect to the `animaldb` database. | ||
| This step is necessary for the SDK to distinguish the `EXAMPLES` custom service | ||
| name from the default service name which is `CLOUDANT`. | ||
| This example code creates `orders` database and adds a new document "example" | ||
| into it. To connect, you must set your environment variables with | ||
| the *service url*, *authentication type* and *authentication credentials* | ||
| of your Cloudant service. | ||
@@ -243,9 +241,3 @@ Cloudant environment variable naming starts with a *service name* prefix that identifies your service. | ||
| you must use your defined service name as the prefix for all Cloudant related environment variables. | ||
| The code block below provides an example of instantiating a user-defined `EXAMPLES` service name. | ||
| ```bash | ||
| EXAMPLES_URL=https://examples.cloudant.com | ||
| EXAMPLES_AUTH_TYPE=NOAUTH | ||
| ``` | ||
| Once the environment variables are set, you can try out the code examples. | ||
@@ -259,132 +251,2 @@ | ||
| ``` | ||
| [embedmd]:# (test/examples/src/ts/GetInfoFromExistingDatabase.ts /\/\/ 1./ $) | ||
| ```ts | ||
| // 1. Create a Cloudant client with "EXAMPLES" service name ===================== | ||
| const client = CloudantV1.newInstance({ serviceName: 'EXAMPLES' }); | ||
| // 2. Get server information ==================================================== | ||
| // call service without parameters: | ||
| client.getServerInformation().then((serverInformation) => { | ||
| const { version } = serverInformation.result; | ||
| console.log(`Server version ${version}`); | ||
| }); | ||
| // 3. Get database information for "animaldb" =================================== | ||
| const dbName = 'animaldb'; | ||
| // call service with embedded parameters: | ||
| client.getDatabaseInformation({ db: dbName }).then((dbInfo) => { | ||
| const documentCount = dbInfo.result.doc_count; | ||
| const dbNameResult = dbInfo.result.db_name; | ||
| // 4. Show document count in database ========================================= | ||
| console.log( | ||
| `Document count in "${dbNameResult}" database is ${documentCount}.` | ||
| ); | ||
| }); | ||
| // 5. Get zebra document out of the database by document id ===================== | ||
| const getDocParams: CloudantV1.GetDocumentParams = { | ||
| db: dbName, | ||
| docId: 'zebra', | ||
| }; | ||
| // call service with predefined parameters: | ||
| client.getDocument(getDocParams).then((documentAboutZebra) => { | ||
| // result object is defined as a Document here: | ||
| const { result } = documentAboutZebra; | ||
| console.log( | ||
| `Document retrieved from database:\n${JSON.stringify(result, null, 2)}` | ||
| ); | ||
| }); | ||
| ``` | ||
| </details> | ||
| <details> | ||
| <summary>JavaScript:</summary> | ||
| ```js | ||
| const { CloudantV1 } = require('@ibm-cloud/cloudant'); | ||
| ``` | ||
| [embedmd]:# (test/examples/src/js/GetInfoFromExistingDatabase.js /const getInfoFromExistingDatabase/ /getInfoFromExistingDatabase\(\);\n\}/) | ||
| ```js | ||
| const getInfoFromExistingDatabase = async () => { | ||
| // 1. Create a Cloudant client with "EXAMPLES" service name =================== | ||
| const client = CloudantV1.newInstance({ serviceName: 'EXAMPLES' }); | ||
| // 2. Get server information ================================================== | ||
| // call service without parameters: | ||
| const { version } = (await client.getServerInformation()).result; | ||
| console.log(`Server version ${version}`); | ||
| // 3. Get database information for "animaldb" ================================= | ||
| const dbName = 'animaldb'; | ||
| // call service with embedded parameters: | ||
| const dbInfo = await client.getDatabaseInformation({ db: dbName }); | ||
| const documentCount = dbInfo.result.doc_count; | ||
| const dbNameResult = dbInfo.result.db_name; | ||
| // 4. Show document count in database ========================================= | ||
| console.log( | ||
| `Document count in "${dbNameResult}" database is ${documentCount}.` | ||
| ); | ||
| // 5. Get zebra document out of the database by document id =================== | ||
| const getDocParams = { db: dbName, docId: 'zebra' }; | ||
| // call service with predefined parameters: | ||
| const documentAboutZebra = await client.getDocument(getDocParams); | ||
| // result object is defined as a Document here: | ||
| const { result } = documentAboutZebra; | ||
| console.log( | ||
| `Document retrieved from database:\n${JSON.stringify(result, null, 2)}` | ||
| ); | ||
| }; | ||
| if (require.main === module) { | ||
| getInfoFromExistingDatabase(); | ||
| } | ||
| ``` | ||
| </details> | ||
| When you run the code, you see a result similar to the following output. | ||
| [embedmd]:# (test/examples/output/GetInfoFromExistingDatabase.txt) | ||
| ```txt | ||
| Server version 2.1.1 | ||
| Document count in "animaldb" database is 11. | ||
| Document retrieved from database: | ||
| { | ||
| "_id": "zebra", | ||
| "_rev": "3-750dac460a6cc41e6999f8943b8e603e", | ||
| "wiki_page": "http://en.wikipedia.org/wiki/Plains_zebra", | ||
| "min_length": 2, | ||
| "max_length": 2.5, | ||
| "min_weight": 175, | ||
| "max_weight": 387, | ||
| "class": "mammal", | ||
| "diet": "herbivore" | ||
| } | ||
| ``` | ||
| #### 2. Create your own database and add a document | ||
| **Note:** This example code assumes that `orders` database does not exist in your account. | ||
| Now comes the exciting part, you create your own `orders` database and add a document about *Bob Smith* with your own [IAM](#iam-authentication) or | ||
| [Basic](#basic-authentication) service credentials. | ||
| <details> | ||
| <summary>Create code example</summary> | ||
| <details open> | ||
| <summary>TypeScript:</summary> | ||
| ```ts | ||
| import {CloudantV1} from "@ibm-cloud/cloudant"; | ||
| ``` | ||
| [embedmd]:# (test/examples/src/ts/CreateDbAndDoc.ts /interface/ $) | ||
@@ -540,4 +402,2 @@ ```ts | ||
| </details> | ||
| When you run the code, you see a result similar to the following output. | ||
@@ -557,2 +417,130 @@ | ||
| #### 2. Retrieve information from an existing database | ||
| **Note**: This example code assumes that you have created both the `orders` | ||
| database and the `example` document by | ||
| [running the previous example code](#1-create-a-database-and-add-a-document) | ||
| successfully. Otherwise, the following error message occurs, "Cannot delete document because either 'orders' | ||
| database or 'example' document was not found." | ||
| <details> | ||
| <summary>Gather database information example</summary> | ||
| <details open> | ||
| <summary>TypeScript:</summary> | ||
| ```ts | ||
| import {CloudantV1} from "@ibm-cloud/cloudant"; | ||
| ``` | ||
| [embedmd]:# (test/examples/src/ts/GetInfoFromExistingDatabase.ts /\/\/ 1./ $) | ||
| ```ts | ||
| // 1. Create a client with `CLOUDANT` default service name ===================== | ||
| const client = CloudantV1.newInstance({}); | ||
| // 2. Get server information ==================================================== | ||
| // call service without parameters: | ||
| client.getServerInformation().then((serverInformation) => { | ||
| const { version } = serverInformation.result; | ||
| console.log(`Server version ${version}`); | ||
| }); | ||
| // 3. Get database information for "orders" =================================== | ||
| const dbName = 'orders'; | ||
| // call service with embedded parameters: | ||
| client.getDatabaseInformation({ db: dbName }).then((dbInfo) => { | ||
| const documentCount = dbInfo.result.doc_count; | ||
| const dbNameResult = dbInfo.result.db_name; | ||
| // 4. Show document count in database ========================================= | ||
| console.log( | ||
| `Document count in "${dbNameResult}" database is ${documentCount}.` | ||
| ); | ||
| }); | ||
| // 5. Get "example" document out of the database by document id ===================== | ||
| const getDocParams: CloudantV1.GetDocumentParams = { | ||
| db: dbName, | ||
| docId: 'example', | ||
| }; | ||
| // call service with predefined parameters: | ||
| client.getDocument(getDocParams).then((documentExample) => { | ||
| // result object is defined as a Document here: | ||
| const { result } = documentExample; | ||
| console.log( | ||
| `Document retrieved from database:\n${JSON.stringify(result, null, 2)}` | ||
| ); | ||
| }); | ||
| ``` | ||
| </details> | ||
| <details> | ||
| <summary>JavaScript:</summary> | ||
| ```js | ||
| const { CloudantV1 } = require('@ibm-cloud/cloudant'); | ||
| ``` | ||
| [embedmd]:# (test/examples/src/js/GetInfoFromExistingDatabase.js /const getInfoFromExistingDatabase/ /getInfoFromExistingDatabase\(\);\n\}/) | ||
| ```js | ||
| const getInfoFromExistingDatabase = async () => { | ||
| // 1. Create a client with `CLOUDANT` default service name =================== | ||
| const client = CloudantV1.newInstance({}); | ||
| // 2. Get server information ================================================== | ||
| // call service without parameters: | ||
| const { version } = (await client.getServerInformation()).result; | ||
| console.log(`Server version ${version}`); | ||
| // 3. Get database information for "orders" ================================= | ||
| const dbName = 'orders'; | ||
| // call service with embedded parameters: | ||
| const dbInfo = await client.getDatabaseInformation({ db: dbName }); | ||
| const documentCount = dbInfo.result.doc_count; | ||
| const dbNameResult = dbInfo.result.db_name; | ||
| // 4. Show document count in database ========================================= | ||
| console.log( | ||
| `Document count in "${dbNameResult}" database is ${documentCount}.` | ||
| ); | ||
| // 5. Get "example" document out of the database by document id =================== | ||
| const getDocParams = { db: dbName, docId: 'example' }; | ||
| // call service with predefined parameters: | ||
| const documentExample = await client.getDocument(getDocParams); | ||
| // result object is defined as a Document here: | ||
| const { result } = documentExample; | ||
| console.log( | ||
| `Document retrieved from database:\n${JSON.stringify(result, null, 2)}` | ||
| ); | ||
| }; | ||
| if (require.main === module) { | ||
| getInfoFromExistingDatabase(); | ||
| } | ||
| ``` | ||
| </details> | ||
| </details> | ||
| When you run the code, you see a result similar to the following output. | ||
| [embedmd]:# (test/examples/output/GetInfoFromExistingDatabase.txt) | ||
| ```txt | ||
| Server version 2.1.1 | ||
| Document count in "orders" database is 1. | ||
| Document retrieved from database: | ||
| { | ||
| "_id": "example", | ||
| "_rev": "1-1b403633540686aa32d013fda9041a5d", | ||
| "name": "Bob Smith", | ||
| "joined": "2019-01-24T10:42:59.000Z" | ||
| } | ||
| ``` | ||
| #### 3. Update your previously created document | ||
@@ -562,3 +550,3 @@ | ||
| database and the `example` document by | ||
| [running the previous example code](#2-create-your-own-database-and-add-a-document) | ||
| [running the previous example code](#1-create-a-database-and-add-a-document) | ||
| successfully. Otherwise, the following error message occurs, "Cannot update document because either 'orders' | ||
@@ -782,3 +770,3 @@ database or 'example' document was not found." | ||
| database and the `example` document by | ||
| [running the previous example code](#2-create-your-own-database-and-add-a-document) | ||
| [running the previous example code](#1-create-a-database-and-add-a-document) | ||
| successfully. Otherwise, the following error message occurs, "Cannot delete document because either 'orders' | ||
@@ -785,0 +773,0 @@ database or 'example' document was not found." |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-0.04%
955313
- Lines of code
- decreased by-0.01%
13972
- Number of lines in readme file
- decreased by-1.24%
958
Dependency changes
+ Added@types/node@14.18.31(transitive)
- Removed@types/node@14.18.25(transitive)
Updated@types/node@14.18.31