Merge pull request #10 from happy-game/master

完成打包发布到 npm

Author: happy-game

docs/pages/apis/client.mdx

@@ -34,7 +34,7 @@ type Config = {
 example to create a client with specific connection information:
 
 ```js
-import { Client } from 'gaussdb'
+import { Client } from 'gaussdb-node'
 
 const client = new Client({
   user: 'database-user',
@@ -48,7 +48,7 @@ const client = new Client({
 ## client.connect
 
 ```js
-import { Client } from 'gaussdb'
+import { Client } from 'gaussdb-node'
 const client = new Client()
 
 await client.connect()
@@ -90,7 +90,7 @@ client.query(text: string, values?: any[]) => Promise<Result>
 **Plain text query**
 
 ```js
-import { Client } from 'gaussdb'
+import { Client } from 'gaussdb-node'
 const client = new Client()
 
 await client.connect()
@@ -104,7 +104,7 @@ await client.end()
 **Parameterized query**
 
 ```js
-import { Client } from 'gaussdb'
+import { Client } from 'gaussdb-node'
 const client = new Client()
 
 await client.connect()
@@ -142,7 +142,7 @@ await client.end()
 If you pass an object to `client.query` and the object has a `.submit` function on it, the client will pass it's GaussDB server connection to the object and delegate query dispatching to the supplied object. This is an advanced feature mostly intended for library authors. It is incidentally also currently how the callback and promise based queries above are handled internally, but this is subject to change. It is also how [gaussdb-cursor](https://github.com/HuaweiCloudDeveloper/gaussdb-node/tree/master/packages/gaussdb-cursor) and [gaussdb-query-stream](https://github.com/HuaweiCloudDeveloper/gaussdb-node/tree/master/packages/gaussdb-query-stream) work.
 
 ```js
-import { Query } from 'gaussdb'
+import { Query } from 'gaussdb-node'
 const query = new Query('select $1::text as name', ['brianc'])
 
 const result = client.query(query)

docs/pages/apis/cursor.mdx

@@ -18,7 +18,7 @@ $ npm install gaussdb gaussdb-cursor
 Instantiates a new Cursor. A cursor is an instance of `Submittable` and should be passed directly to the `client.query` method.
 
 ```js
-import { Pool } from 'gaussdb'
+import { Pool } from 'gaussdb-node'
 import Cursor from 'gaussdb-cursor'
 
 const pool = new Pool()
@@ -55,7 +55,7 @@ If the cursor has read to the end of the result sets all subsequent calls to cur
 Here is an example of reading to the end of a cursor:
 
 ```js
-import { Pool } from 'gaussdb'
+import { Pool } from 'gaussdb-node'
 import Cursor from 'gaussdb-cursor'
 
 const pool = new Pool()

docs/pages/apis/pool.mdx

@@ -56,7 +56,7 @@ type Config = {
 example to create a new pool with configuration:
 
 ```js
-import { Pool } from 'gaussdb'
+import { Pool } from 'gaussdb-node'
 
 const pool = new Pool({
   host: 'localhost',
@@ -76,7 +76,7 @@ pool.query(text: string, values?: any[]) => Promise<gaussdb.Result>
 ```
 
 ```js
-import { Pool } from 'gaussdb'
+import { Pool } from 'gaussdb-node'
 
 const pool = new Pool()
 
@@ -108,7 +108,7 @@ Acquires a client from the pool.
 - If the pool is 'full' and all clients are currently checked out will wait in a FIFO queue until a client becomes available by it being released back to the pool.
 
 ```js
-import { Pool } from 'gaussdb'
+import { Pool } from 'gaussdb-node'
 
 const pool = new Pool()
 
@@ -126,7 +126,7 @@ Client instances returned from `pool.connect` will have a `release` method which
 The `release` method on an acquired client returns it back to the pool. If you pass a truthy value in the `destroy` parameter, instead of releasing the client to the pool, the pool will be instructed to disconnect and destroy this client, leaving a space within itself for a new client.
 
 ```js
-import { Pool } from 'gaussdb'
+import { Pool } from 'gaussdb-node'
 
 const pool = new Pool()
 
@@ -138,7 +138,7 @@ client.release()
 ```
 
 ```js
-import { Pool } from 'gaussdb'
+import { Pool } from 'gaussdb-node'
 
 const pool = new Pool()
 assert(pool.totalCount === 0)
@@ -171,7 +171,7 @@ Calling `pool.end` will drain the pool of all active clients, disconnect them, a
 
 ```js
 // again both promises and callbacks are supported:
-import { Pool } from 'gaussdb'
+import { Pool } from 'gaussdb-node'
 
 const pool = new Pool()
 

docs/pages/apis/result.mdx

@@ -18,7 +18,7 @@ Every result will have a rows array. If no rows are returned the array will be e
 Every result will have a fields array. This array contains the `name` and `dataTypeID` of each field in the result. These fields are ordered in the same order as the columns if you are using `arrayMode` for the query:
 
 ```js
-import gaussdb from 'gaussdb'
+import gaussdb from 'gaussdb-node'
 const { Pool } = gaussdb
 
 const pool = new Pool()

docs/pages/apis/utilities.mdx

@@ -9,7 +9,7 @@ import { Alert } from '/components/alert.tsx'
 Escapes a string as a [SQL identifier](https://www.gaussdb.org/docs/current/sql-syntax-lexical.html#SQL-SYNTAX-IDENTIFIERS).
 
 ```js
-import { escapeIdentifier } from 'gaussdb';
+import { escapeIdentifier } from 'gaussdb-node';
 const escapedIdentifier = escapeIdentifier('FooIdentifier')
 console.log(escapedIdentifier) // '"FooIdentifier"'
 ```
@@ -27,7 +27,7 @@ console.log(escapedIdentifier) // '"FooIdentifier"'
 Escapes a string as a [SQL literal](https://www.gaussdb.org/docs/current/sql-syntax-lexical.html#SQL-SYNTAX-CONSTANTS).
 
 ```js
-import { escapeLiteral } from 'gaussdb';
+import { escapeLiteral } from 'gaussdb-node';
 const escapedLiteral = escapeLiteral("hello 'world'")
 console.log(escapedLiteral) // "'hello ''world'''"
 ```

docs/pages/features/callbacks.mdx

@@ -8,7 +8,7 @@ title: Callbacks
 
 
 ```js
-const { Pool, Client } = require('gaussdb')
+const { Pool, Client } = require('gaussdb-node')
 
 // pool
 const pool = new Pool()

docs/pages/features/connecting.mdx

@@ -9,7 +9,7 @@ Both individual clients & pools will use these environment variables. Here's a t
 Both individual clients & pools will use these environment variables. Here's a tiny program connecting node.js to the GaussDB server:
 
 ```js
-import gaussdb from 'gaussdb'
+import gaussdb from 'gaussdb-node'
 const { Pool, Client } = gaussdb
 
 // pools will use environment variables
@@ -57,7 +57,7 @@ GAUSSDB_DATABASE=process.env.USER (fallback to GAUSSDATABASE)
 gaussdb-node also supports configuring a pool or client programmatically with connection information. Here's our same script from above modified to use programmatic (hard-coded in this case) values. This can be useful if your application already has a way to manage config values or you don't want to use environment variables.
 
 ```js
-import gaussdb from 'gaussdb'
+import gaussdb from 'gaussdb-node'
 const { Pool, Client } = gaussdb
 
 const pool = new Pool({
@@ -88,7 +88,7 @@ await client.end()
 Many cloud providers include alternative methods for connecting to database instances using short-lived authentication tokens. gaussdb-node supports dynamic passwords via a callback function, either synchronous or asynchronous. The callback function must resolve to a string.
 
 ```js
-import gaussdb from 'gaussdb'
+import gaussdb from 'gaussdb-node'
 const { Pool } = gaussdb
 import { RDS } from 'aws-sdk'
 
@@ -121,7 +121,7 @@ const pool = new Pool({
 Connections to unix sockets can also be made. This can be useful on distros like Ubuntu, where authentication is managed via the socket connection instead of a password.
 
 ```js
-import gaussdb from 'gaussdb'
+import gaussdb from 'gaussdb-node'
 const { Client } = gaussdb
 client = new Client({
   user: 'username',
@@ -136,7 +136,7 @@ client = new Client({
 You can initialize both a pool and a client with a connection string URI as well. This is common in environments like Heroku where the database connection string is supplied to your application dyno through an environment variable. Connection string parsing brought to you by [gaussdb-connection-string](https://github.com/HuaweiCloudDeveloper/gaussdb-node/tree/master/packages/gaussdb-connection-string).
 
 ```js
-import gaussdb from 'gaussdb'
+import gaussdb from 'gaussdb-node'
 const { Pool, Client } = gaussdb
 const connectionString = 'gaussdb://dbuser:[email protected]:3211/mydb'
 

docs/pages/features/esm.mdx

@@ -4,7 +4,7 @@ title: ESM
 
 ## ESM Support
 
-As of v8.15.x gaussdb-node supporters the __ECMAScript Module__ (ESM) format. This means you can use `import` statements instead of `require` or `import gaussdb from 'gaussdb'`.
+As of v8.15.x gaussdb-node supporters the __ECMAScript Module__ (ESM) format. This means you can use `import` statements instead of `require` or `import gaussdb from 'gaussdb-node'`.
 
 CommonJS modules are still supported. The ESM format is an opt-in feature and will not affect existing codebases that use CommonJS.
 
@@ -13,7 +13,7 @@ The docs have been changed to show ESM usage, but in a CommonJS context you can
 If you're using CommonJS, you can use the following code to import the `gaussdb` module:
 
 ```js
-  const gaussdb = require('gaussdb')
+  const gaussdb = require('gaussdb-node')
   const { Client } = gaussdb
   // etc...
 ```
@@ -23,15 +23,15 @@ If you're using CommonJS, you can use the following code to import the `gaussdb`
 If you're using ESM, you can use the following code to import the `gaussdb` module:
 
 ```js
-  import { Client } from 'gaussdb'
+  import { Client } from 'gaussdb-node'
   // etc...
 ```
 
 
 Previously if you were using ESM you would have to use the following code:
 
 ```js
-  import gaussdb from 'gaussdb'
+  import gaussdb from 'gaussdb-node'
   const { Client } = gaussdb
   // etc...
 ```

docs/pages/features/native.mdx

@@ -15,12 +15,12 @@ $ npm install gaussdb pg-native
 Once `pg-native` is installed instead of requiring a `Client` or `Pool` constructor from `gaussdb` you do the following:
 
 ```js
-import gaussdb from 'gaussdb'
+import gaussdb from 'gaussdb-node'
 const { native } = gaussdb
 const { Client, Pool } = native
 ```
 
-When you access the `.native` property on `'gaussdb'` it will automatically require the `pg-native` package and wrap it in the same API.
+When you access the `.native` property on `'gaussdb-node'` it will automatically require the `pg-native` package and wrap it in the same API.
 
 <div class='alert alert-warning'>
   Care has been taken to normalize between the two, but there might still be edge cases where things behave subtly differently due to the nature of using libpq over handling the binary protocol directly in JavaScript, so it's recommended you chose to either use the JavaScript driver or the native bindings both in development and production.  For what its worth: I use the pure JavaScript driver because the JavaScript driver is more portable (doesn't need a compiler), and the pure JavaScript driver is <em>plenty</em> fast.

docs/pages/features/pooling.mdx

@@ -28,7 +28,7 @@ The client pool allows you to have a reusable pool of clients you can check out,
 ### Checkout, use, and return
 
 ```js
-import gaussdb from 'gaussdb'
+import gaussdb from 'gaussdb-node'
 const { Pool } = gaussdb
 
 const pool = new Pool()
@@ -61,7 +61,7 @@ client.release()
 If you don't need a transaction or you just need to run a single query, the pool has a convenience method to run a query on any available client in the pool. This is the preferred way to query with gaussdb-node if you can as it removes the risk of leaking a client.
 
 ```js
-import gaussdb from 'gaussdb'
+import gaussdb from 'gaussdb-node'
 const { Pool } = gaussdb
 
 const pool = new Pool()
@@ -75,7 +75,7 @@ console.log('user:', res.rows[0])
 To shut down a pool call `pool.end()` on the pool. This will wait for all checked-out clients to be returned and then shut down all the clients and the pool timers.
 
 ```js
-import gaussdb from 'gaussdb'
+import gaussdb from 'gaussdb-node'
 const { Pool } = gaussdb
 const pool = new Pool()