testing workflow

Author: psharma-1909

.github/workflows/gh-pages.yml

@@ -3,6 +3,7 @@ on:
   push:
     branches:
       - master
+      - psharma/update_readme
     paths:
       - 'website/**'
   workflow_dispatch:

website/docs/contributing/00-index.mdx

@@ -1,6 +1,6 @@
 ---
 slug: /contributing
-title: MySQL2
+title: SINGLESTORE-NODEJS
 ---
 
 import { PageTitle } from '@site/src/components/PageTitle';
@@ -9,5 +9,5 @@ import { PageTitle } from '@site/src/components/PageTitle';
 
 # Contributing
 
-Want to improve something in **MySQL2**?
-Please check [Contributing.md](https://github.com/sidorares/node-mysql2/blob/master/Contributing.md) for detailed instruction on how to get started.
+Want to improve something in **singlestore-nodejs**?
+Please check [Contributing.md](https://github.com/singlestore-labs/singlestore-nodejs/blob/master/Contributing.md) for detailed instruction on how to get started.

website/docs/contributing/website.mdx

@@ -23,12 +23,12 @@ You will need these tools installed on your system:
 
 ## Development
 
-1. Fork the [MySQL2](https://github.com/sidorares/node-mysql2) repository.
-2. Download your forked repository locally. The website's workspace is the "_website_" directory in **node-mysql2** root.
+1. Fork the [SingleStore Node.js Driver](https://github.com/singlestore-labs/singlestore-nodejs) repository.
+2. Download your forked repository locally. The website's workspace is the "_website_" directory in **singlestore-nodejs** root.
 3. Create a new branch from `master` (optional).
 4. Run `cd website` to enter the website workspace.
-5. Run `npm ci` to install the dependecies from _package-lock.json_.
-6. Run `npm start` to starting the local development.
+5. Run `npm ci` to install the dependencies from _package-lock.json_.
+6. Run `npm start` to start the local development.
 
 > It will start a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
 
@@ -37,9 +37,9 @@ For **Docusaurus** complete documentation, please [see here](https://docusaurus.
 <FAQ title='CLI example'>
 
 ```bash
-git clone https://github.com/sidorares/node-mysql2.git
+git clone https://github.com/singlestore-labs/singlestore-nodejs.git
 git checkout -b website # optional
-cd /path-to/node-mysql2/website
+cd /path-to/singlestore-nodejs/website
 npm ci
 npm start
 ```
@@ -55,7 +55,7 @@ Documentation is auto-generated from **MDX** files placed in these directories:
 :::danger Caution
 Note that the website has its own _package.json_.
 
-Please, do not install dependencies for the website in **node-mysql2** root.
+Please, do not install dependencies for the website in **singlestore-nodejs** root.
 :::
 
 <hr />
@@ -181,12 +181,12 @@ import { ExternalCodeEmbed } from '@site/src/components/ExternalCodeEmbed';
 
 <FAQ title='Example'>
   <ExternalCodeEmbed
-    url='https://raw.githubusercontent.com/sidorares/node-mysql2/master/.prettierrc'
+    url='https://raw.githubusercontent.com/singlestore-labs/singlestore-nodejs/master/.prettierrc'
     language='json'
   />
 
   <ExternalCodeEmbed
-    url='https://raw.githubusercontent.com/sidorares/node-mysql2/master/tools/parse-row.js'
+    url='https://raw.githubusercontent.com/singlestore-labs/singlestore-nodejs/master/tools/parse-row.js'
     language='js'
     extractMethod='parseC'
     methodType='function'

website/docs/documentation/00-index.mdx

@@ -9,15 +9,15 @@ import { PageTitle } from '@site/src/components/PageTitle';
 
 # Documentation
 
-[node-mysql]: https://github.com/mysqljs/mysql
+[node-mysql2]: https://github.com/sidorares/node-mysql2
 
-MySQL2 aims to be a drop in replacement for [Node MySQL][node-mysql].
+**singlestore-nodejs** is a Node.js driver for SingleStoreDB, forked from [node-mysql2][node-mysql2]. It maintains compatibility with the MySQL protocol while providing optimized support for SingleStoreDB features.
 
 :::note
-_If you see any API incompatibilities with [Node MySQL][node-mysql], please report via github issue._
+_This driver is based on [node-mysql2][node-mysql2] and maintains API compatibility. If you encounter any issues specific to SingleStoreDB, please report via GitHub issue._
 :::
 
-Not only **MySQL2** offers better performance over [Node MySQL][node-mysql], we also support these additional features:
+**singlestore-nodejs** offers:
 
 - [Prepared Statements](/docs/documentation/prepared-statements)
 - [Promise Wrapper](/docs/documentation/promise-wrapper)
@@ -33,7 +33,7 @@ Not only **MySQL2** offers better performance over [Node MySQL][node-mysql], we
 
 ## Examples
 
-Please check these [examples](/docs/examples) for **MySQL2**.
+Please check these [examples](/docs/examples) for **singlestore-nodejs**.
 
 <hr />
 
@@ -66,17 +66,13 @@ This option could lose precision on the number as Javascript Number is a Float!
 
 ## Other Resources
 
-- [Wire protocol documentation](https://dev.mysql.com/doc/internals/en/client-server-protocol.html)
-- [Node MySQL][node-mysql] - Most popular node.js mysql client library
-- [node-mariasql](https://github.com/mscdex/node-mariasql/) - Bindings to libmariasql. One of the fastest clients
-- [node-libmysqlclient](https://github.com/Sannis/node-mysql-libmysqlclient) - Bindings to libmysqlclient
-- [go-mysql](https://github.com/siddontang/go-mysql) - MySQL Go client (prepared statements, binlog protocol, server)
+- [SingleStoreDB Documentation](https://docs.singlestore.com/)
+- [MySQL Wire Protocol Documentation](https://dev.mysql.com/doc/internals/en/client-server-protocol.html)
+- [node-mysql2][node-mysql2] - The upstream MySQL client library this driver is based on
 
 <hr />
 
 ## Benchmarks
 
-- https://gist.github.com/sidorares/ffe9ee9c423f763e3b6b
 - `npm run benchmarks`
-- [node-mysql-benchmarks](https://github.com/mscdex/node-mysql-benchmarks)
-- try to run example [benchmarks](https://github.com/sidorares/node-mysql2/tree/master/benchmarks) on your system
+- try to run example [benchmarks](https://github.com/singlestore-labs/singlestore-nodejs/tree/master/benchmarks) on your system

website/docs/index.mdx

@@ -2,7 +2,7 @@
 slug: /
 position: 1
 title: Quickstart
-description: MySQL client for Node.js with focus on performance
+description: SingleStore client for Node.js with focus on performance
 ---
 
 import Tabs from '@theme/Tabs';
@@ -11,19 +11,19 @@ import { PageTitle } from '@site/src/components/PageTitle';
 
 <PageTitle title='SingleStore-Nodejs | Quickstart' />
 
-[npm-image]: https://img.shields.io/npm/v/mysql2.svg
-[npm-url]: https://npmjs.org/package/mysql2
-[node-version-image]: https://img.shields.io/node/v/mysql2.svg
+[npm-image]: https://img.shields.io/npm/v/singlestore-nodejs.svg
+[npm-url]: https://npmjs.org/package/singlestore-nodejs
+[node-version-image]: https://img.shields.io/node/v/singlestore-nodejs.svg
 [node-version-url]: https://nodejs.org/download/
-[downloads-image]: https://img.shields.io/npm/dm/mysql2.svg
-[downloads-url]: https://npmjs.org/package/mysql2
-[license-url]: https://github.com/sidorares/node-mysql2/blob/master/License
-[license-image]: https://img.shields.io/npm/l/mysql2.svg?maxAge=2592000
+[downloads-image]: https://img.shields.io/npm/dm/singlestore-nodejs.svg
+[downloads-url]: https://npmjs.org/package/singlestore-nodejs
+[license-url]: https://github.com/singlestore-labs/singlestore-nodejs/blob/master/License
+[license-image]: https://img.shields.io/npm/l/singlestore-nodejs.svg?maxAge=2592000
 [node-mysql]: https://github.com/mysqljs/mysql
-[coverage]: https://img.shields.io/codecov/c/github/sidorares/node-mysql2
-[coverage-url]: https://app.codecov.io/github/sidorares/node-mysql2
-[ci-url]: https://github.com/sidorares/node-mysql2/actions/workflows/ci-coverage.yml?query=branch%3Amaster
-[ci-image]: https://img.shields.io/github/actions/workflow/status/sidorares/node-mysql2/ci-coverage.yml?event=push&style=flat&label=CI&branch=master
+[coverage]: https://img.shields.io/codecov/c/github/singlestore-labs/singlestore-nodejs
+[coverage-url]: https://app.codecov.io/github/singlestore-labs/singlestore-nodejs
+[ci-url]: https://github.com/singlestore-labs/singlestore-nodejs/actions/workflows/ci-coverage.yml?query=branch%3Amaster
+[ci-image]: https://img.shields.io/github/actions/workflow/status/singlestore-labs/singlestore-nodejs/ci-coverage.yml?event=push&style=flat&label=CI&branch=master
 
 # SingleStore-Nodejs
 
@@ -40,20 +40,20 @@ SingleStore client for Node.js with focus on performance. Supports prepared stat
 
 ## Installation
 
-MySQL2 is free from native bindings and can be installed on Linux, Mac OS or Windows without any issues.
+SingleStore-Nodejs is free from native bindings and can be installed on Linux, Mac OS or Windows without any issues.
 
 <Tabs>
   <TabItem value='JavaScript' default>
 
 ```bash
-npm install --save mysql2
+npm install --save singlestore-nodejs
 ```
 
   </TabItem>
   <TabItem value='TypeScript'>
 
 ```bash
-npm install --save mysql2
+npm install --save singlestore-nodejs
 npm install --save-dev @types/node
 ```
 
@@ -73,10 +73,10 @@ npm install --save-dev @types/node
 
 ```js
 // Get the client
-import mysql from 'mysql2/promise';
+import singlestore from 'singlestore-nodejs/promise';
 
 // Create the connection to database
-const connection = await mysql.createConnection({
+const connection = await singlestore.createConnection({
   host: 'localhost',
   user: 'root',
   database: 'test',
@@ -112,10 +112,10 @@ try {
 
 ```js
 // Get the client
-const mysql = require('mysql2');
+const singlestore = require('singlestore-nodejs');
 
 // Create the connection to database
-const connection = mysql.createConnection({
+const connection = singlestore.createConnection({
   host: 'localhost',
   user: 'root',
   database: 'test',
@@ -147,23 +147,23 @@ connection.query(
 
 ### Using Prepared Statements
 
-With MySQL2 you also get the prepared statements. With prepared statements MySQL doesn't have to prepare plan for same query every time, this results in better performance. If you don't know why they are important, please check these discussions:
+With SingleStore-Nodejs you also get the prepared statements. With prepared statements SingleStore doesn't have to prepare plan for same query every time, this results in better performance. If you don't know why they are important, please check these discussions:
 
 - [How prepared statements can protect from SQL Injection attacks](https://stackoverflow.com/questions/8263371/how-can-prepared-statements-protect-from-sql-injection-attacks)
 
-MySQL2 provides `execute` helper which will prepare and query the statement. You can also manually prepare / unprepare statement with `prepare` / `unprepare` methods.
+SingleStore-Nodejs provides `execute` helper which will prepare and query the statement. You can also manually prepare / unprepare statement with `prepare` / `unprepare` methods.
 
 > To explore more Prepared Statements and Placeholders examples, please visit the example section [**Prepared Statements**](/docs/examples/queries/prepared-statements).
 
 <Tabs>
   <TabItem value='Promise' default>
 
 ```js
-import mysql from 'mysql2/promise';
+import singlestore from 'singlestore-nodejs/promise';
 
 try {
   // create the connection to database
-  const connection = await mysql.createConnection({
+  const connection = await singlestore.createConnection({
     host: 'localhost',
     user: 'root',
     database: 'test',
@@ -186,10 +186,10 @@ try {
   <TabItem value='Callback'>
 
 ```js
-const mysql = require('mysql2');
+const singlestore = require('singlestore-nodejs');
 
 // create the connection to database
-const connection = mysql.createConnection({
+const connection = singlestore.createConnection({
   host: 'localhost',
   user: 'root',
   database: 'test',
@@ -217,7 +217,7 @@ If you execute same statement again, it will be picked from a LRU cache which wi
 
 ### Using Connection Pools
 
-Connection pools help reduce the time spent connecting to the MySQL server by reusing a previous connection, leaving them open instead of closing when you are done with them.
+Connection pools help reduce the time spent connecting to the SingleStore server by reusing a previous connection, leaving them open instead of closing when you are done with them.
 
 This improves the latency of queries as you avoid all of the overhead that comes with establishing a new connection.
 
@@ -227,10 +227,10 @@ This improves the latency of queries as you avoid all of the overhead that comes
   <TabItem value='Promise' default>
 
 ```js
-import mysql from 'mysql2/promise';
+import singlestore from 'singlestore-nodejs/promise';
 
 // Create the connection pool. The pool-specific settings are the defaults
-const pool = mysql.createPool({
+const pool = singlestore.createPool({
   host: 'localhost',
   user: 'root',
   database: 'test',
@@ -248,10 +248,10 @@ const pool = mysql.createPool({
     <TabItem value='Callback'>
 
 ```js
-const mysql = require('mysql2');
+const singlestore = require('singlestore-nodejs');
 
 // Create the connection pool. The pool-specific settings are the defaults
-const pool = mysql.createPool({
+const pool = singlestore.createPool({
   host: 'localhost',
   user: 'root',
   database: 'test',
@@ -345,14 +345,14 @@ conn.release();
 
 ### Using Promise Wrapper
 
-MySQL2 also support Promise API. Which works very well with ES7 async await.
+SingleStore-Nodejs also support Promise API. Which works very well with ES7 async await.
 
 ```js
-import mysql from 'mysql2/promise';
+import singlestore from 'singlestore-nodejs/promise';
 
 async function main() {
   // create the connection
-  const connection = await mysql.createConnection({
+  const connection = await singlestore.createConnection({
     host: 'localhost',
     user: 'root',
     database: 'test',
@@ -366,17 +366,17 @@ async function main() {
 }
 ```
 
-MySQL2 use default `Promise` object available in scope. But you can choose which `Promise` implementation you want to use.
+SingleStore-Nodejs use default `Promise` object available in scope. But you can choose which `Promise` implementation you want to use.
 
 ```js
 // get the client
-import mysql from 'mysql2/promise';
+import singlestore from 'singlestore-nodejs/promise';
 
 // get the promise implementation, we will use bluebird
 import bluebird from 'bluebird';
 
 // create the connection, specify bluebird as Promise
-const connection = await mysql.createConnection({
+const connection = await singlestore.createConnection({
   host: 'localhost',
   user: 'root',
   database: 'test',
@@ -390,14 +390,14 @@ const [rows, fields] = await connection.execute(
 );
 ```
 
-MySQL2 also exposes a `.promise()` function on Pools, so you can create a promise/non-promise connections from the same pool.
+SingleStore-Nodejs also exposes a `.promise()` function on Pools, so you can create a promise/non-promise connections from the same pool.
 
 ```js
-import mysql from 'mysql2';
+import singlestore from 'singlestore-nodejs';
 
 async function main() {
   // create the pool
-  const pool = mysql.createPool({
+  const pool = singlestore.createPool({
     host: 'localhost',
     user: 'root',
     database: 'test',
@@ -411,13 +411,13 @@ async function main() {
 }
 ```
 
-MySQL2 exposes a `.promise()` function on Connections, to "upgrade" an existing non-promise connection to use promise.
+SingleStore-Nodejs exposes a `.promise()` function on Connections, to "upgrade" an existing non-promise connection to use promise.
 
 ```js {11}
-const mysql = require('mysql2');
+const singlestore = require('singlestore-nodejs');
 
 // create the connection
-const conn = mysql.createConnection({
+const conn = singlestore.createConnection({
   host: 'localhost',
   user: 'root',
   database: 'test',
@@ -449,7 +449,7 @@ You can enable this setting at either the connection level (applies to all queri
   <TabItem value='Promise' default>
 
 ```js {5}
-const conn = await mysql.createConnection({
+const conn = await singlestore.createConnection({
   host: 'localhost',
   database: 'test',
   user: 'root',
@@ -461,7 +461,7 @@ const conn = await mysql.createConnection({
   <TabItem value='Callback'>
 
 ```js {5}
-const conn = mysql.createConnection({
+const conn = singlestore.createConnection({
   host: 'localhost',
   database: 'test',
   user: 'root',
@@ -513,6 +513,6 @@ conn.query(
 <hr />
 
 :::tip Getting Help
-Need help? Ask your question on [Stack Overflow](https://stackoverflow.com/questions/tagged/mysql2) or [GitHub](https://github.com/sidorares/node-mysql2/discussions).
-If you've encountered an issue, please [file it on GitHub](https://github.com/sidorares/node-mysql2/issues).
+Need help? Ask your question on [Stack Overflow](https://stackoverflow.com/questions/tagged/singlestore-nodejs) or [GitHub](https://github.com/singlestore-labs/singlestore-nodejs/discussions).
+If you've encountered an issue, please [file it on GitHub](https://github.com/singlestore-labs/singlestore-nodejs/issues).
 :::