[Reference](../../reference/drivers/nodejs/yugabyte-pg-reference/) | [8.7.3-yb-1](https://www.npmjs.com/package/pg) | 2.8 and above | -| PostgreSQL node-postgres Driver| [Documentation](postgres-node-driver/)
[Reference](../../reference/drivers/nodejs/postgres-pg-reference/) | [8.7.3](https://www.npmjs.com/package/pg) | 2.6 and above | +| YugabyteDB node-postgres Smart Driver| [Documentation](yugabyte-node-driver/)
[Reference](yugabyte-pg-reference/) | [8.7.3-yb-1](https://www.npmjs.com/package/pg) | 2.8 and above | +| PostgreSQL node-postgres Driver| [Documentation](postgres-node-driver/)
[Reference](postgres-pg-reference/) | [8.7.3](https://www.npmjs.com/package/pg) | 2.6 and above | | YugabyteDB Node.js Driver for YCQL | [Documentation](ycql/) | [4.0.0](https://github.com/yugabyte/cassandra-nodejs-driver) | | | Project | Documentation and Guides | Example Apps | | :------ | :----------------------- | :----------- | | Sequelize | [Documentation](sequelize/)
[Hello World](../orms/nodejs/ysql-sequelize/) | [Sequelize ORM App](https://github.com/YugabyteDB-Samples/orm-examples/tree/master/node/sequelize) | -| Prisma | [Documentation](prisma/)
[Hello World](../orms/nodejs/ysql-prisma/)
| [Prisma ORM App](https://github.com/yugabyte/orm-examples/tree/master/node/prisma) +| Prisma | [Documentation](prisma/)
[Hello World](../orms/nodejs/ysql-prisma/)
| [Prisma ORM App](https://github.com/yugabyte/orm-examples/tree/master/node/prisma) | Learn how to establish a connection to a YugabyteDB database and begin basic CRUD operations by referring to [Connect an app](yugabyte-node-driver/) or [Use an ORM](sequelize/). -For reference documentation, including using projects with SSL, refer to the [drivers and ORMs reference](../../reference/drivers/nodejs/yugabyte-pg-reference/) pages. - ## Prerequisites To develop Node.js applications for YugabyteDB, you need the following: -- **Node.js**\ - To download and install Node.js, refer to the [Node.js](https://nodejs.org/en/download/) documentation.\ +- **Node.js** + + To download and install Node.js, refer to the [Node.js](https://nodejs.org/en/download/) documentation. + To check the version of node, use the following command: ```sh node -v ``` -- **Create a node.js project**\ +- **Create a node.js project** + Create a file with the `.js` extension (for example `app.js`), which can be run using the following command: ```sh @@ -52,9 +53,10 @@ To develop Node.js applications for YugabyteDB, you need the following: ``` - **YugabyteDB cluster** + - Create a free cluster on YugabyteDB Aeon. Refer to [Use a cloud cluster](../../quick-start-yugabytedb-managed/). Note that YugabyteDB Aeon requires SSL. - Alternatively, set up a standalone YugabyteDB cluster by following the steps in [Install YugabyteDB](../../quick-start/). ## Next step -- [Connect an app](yugabyte-node-driver/) +[Connect an app](yugabyte-node-driver/) diff --git a/docs/content/preview/drivers-orms/nodejs/postgres-node-driver.md b/docs/content/preview/drivers-orms/nodejs/postgres-node-driver.md index 8a4062d02987..c3e43bb6d3c0 100644 --- a/docs/content/preview/drivers-orms/nodejs/postgres-node-driver.md +++ b/docs/content/preview/drivers-orms/nodejs/postgres-node-driver.md @@ -5,9 +5,9 @@ linkTitle: Connect an app description: Connect a node.js application using node-postgres Driver menu: preview: - identifier: postgres-node-driver + identifier: node-driver-2-postgres parent: nodejs-drivers - weight: 600 + weight: 500 type: docs --- @@ -117,7 +117,7 @@ const config = { If you created a cluster on YugabyteDB Aeon, use the cluster credentials and [download the SSL Root certificate](../../../yugabyte-cloud/cloud-connect/connect-applications/). -Refer to [Configure SSL/TLS](../../../reference/drivers/nodejs/postgres-pg-reference/#configure-ssl-tls) for more information on node-postgresql default and supported SSL modes, and other examples for setting up your connection strings when using SSL. +Refer to [Configure SSL/TLS](../postgres-pg-reference/#configure-ssl-tls) for more information on node-postgresql default and supported SSL modes, and other examples for setting up your connection strings when using SSL. ### Step 3: Write your application @@ -275,7 +275,4 @@ If there is no output or you get an error, verify the parameters included in the ## Learn more -- [PostgreSQL node-postgres driver reference](../../../reference/drivers/nodejs/postgres-pg-reference/) -- [YugabyteDB smart drivers for YSQL](../../smart-drivers/) -- Build Node.js applications using [Sequelize ORM](../sequelize/) -- Build Node.js applications using [Prisma ORM](../prisma/) +[YugabyteDB smart drivers for YSQL](../../smart-drivers/) diff --git a/docs/content/preview/reference/drivers/nodejs/postgres-pg-reference.md b/docs/content/preview/drivers-orms/nodejs/postgres-pg-reference.md similarity index 91% rename from docs/content/preview/reference/drivers/nodejs/postgres-pg-reference.md rename to docs/content/preview/drivers-orms/nodejs/postgres-pg-reference.md index 6afc25d6515f..3b2ea4c49645 100644 --- a/docs/content/preview/reference/drivers/nodejs/postgres-pg-reference.md +++ b/docs/content/preview/drivers-orms/nodejs/postgres-pg-reference.md @@ -3,13 +3,15 @@ title: PostgreSQL node-postgres Driver headerTitle: Node.js Drivers linkTitle: Node.js Drivers description: PostgreSQL node-postgres Driver for YSQL -headcontent: Node.js Drivers for YSQL +badges: ysql +aliases: +- /preview/reference/drivers/nodejs/postgres-pg-reference/ menu: preview: name: Node.js Drivers - identifier: ref-postgres-pg-driver - parent: drivers - weight: 600 + identifier: ref-2-postgres-pg-driver + parent: nodejs-drivers + weight: 100 type: docs --- @@ -28,11 +30,11 @@ type: docs -The [PostgreSQL node-postgres driver](https://node-postgres.com/) is the official Node.js driver for PostgreSQL. The YSQL API is fully compatible with the PostgreSQL node-postgres (pg) driver, so you can connect to the YugabyteDB database to execute DMLs and DDLs using the node-postgres APIs. The driver supports the [SCRAM-SHA-256 authentication method](../../../../secure/authentication/password-authentication/#scram-sha-256). +The [PostgreSQL node-postgres driver](https://node-postgres.com/) is the official Node.js driver for PostgreSQL. The YSQL API is fully compatible with the PostgreSQL node-postgres (pg) driver, so you can connect to the YugabyteDB database to execute DMLs and DDLs using the node-postgres APIs. The driver supports the [SCRAM-SHA-256 authentication method](../../../secure/authentication/password-authentication/#scram-sha-256). For details on installing and using node-postgres, see the [node-postgres documentation](https://node-postgres.com/). -For a tutorial on building a Node.js application with node-postgres, see [Connect an application](../../../../drivers-orms/nodejs/postgres-node-driver/). +For a tutorial on building a Node.js application with node-postgres, see [Connect an application](../postgres-node-driver/). ## Fundamentals @@ -93,7 +95,7 @@ client }) ``` -Read more on designing [Database schemas and tables](../../../../explore/ysql-language-features/databases-schemas-tables/). +Read more on designing [Database schemas and tables](../../../explore/ysql-language-features/databases-schemas-tables/). ### Read and write data @@ -140,9 +142,9 @@ client ## Configure SSL/TLS -To build a Node.js application that communicates securely over SSL, get the root certificate (`ca.crt`) of the YugabyteDB Cluster. If certificates are not generated yet, follow the instructions in [Create server certificates](../../../../secure/tls-encryption/server-certificates/). +To build a Node.js application that communicates securely over SSL, get the root certificate (`ca.crt`) of the YugabyteDB Cluster. If certificates are not generated yet, follow the instructions in [Create server certificates](../../../secure/tls-encryption/server-certificates/). -Because a YugabyteDB Aeon cluster is always configured with SSL/TLS, you don't have to generate any certificate but only set the client-side SSL configuration. To fetch your root certificate, refer to [Download your cluster certificate](../../../../yugabyte-cloud/cloud-secure-clusters/cloud-authentication/#download-your-cluster-certificate). +Because a YugabyteDB Aeon cluster is always configured with SSL/TLS, you don't have to generate any certificate but only set the client-side SSL configuration. To fetch your root certificate, refer to [Download your cluster certificate](../../../yugabyte-cloud/cloud-secure-clusters/cloud-authentication/#download-your-cluster-certificate). The node-postgres driver allows you to avoid including the parameters like `sslcert`, `sslkey`, `sslrootcert`, or `sslmode` in the connection string. You can pass the object which includes `connectionString` and `ssl` object which has various fields including the following: @@ -239,7 +241,7 @@ client.connect() ## Transaction and isolation levels -YugabyteDB supports transactions for inserting and querying data from the tables. YugabyteDB supports different [isolation levels](../../../../architecture/transactions/isolation-levels/) for maintaining strong consistency for concurrent data access. +YugabyteDB supports transactions for inserting and querying data from the tables. YugabyteDB supports different [isolation levels](../../../architecture/transactions/isolation-levels/) for maintaining strong consistency for concurrent data access. Node-postgres driver allows transaction using the queries, executed using `client.query()`. diff --git a/docs/content/preview/drivers-orms/nodejs/sequelize.md b/docs/content/preview/drivers-orms/nodejs/sequelize.md index fc9d2404208c..c70094823990 100644 --- a/docs/content/preview/drivers-orms/nodejs/sequelize.md +++ b/docs/content/preview/drivers-orms/nodejs/sequelize.md @@ -10,7 +10,7 @@ menu: preview: identifier: sequelize-1 parent: nodejs-drivers - weight: 500 + weight: 600 type: docs --- diff --git a/docs/content/preview/drivers-orms/nodejs/ycql.md b/docs/content/preview/drivers-orms/nodejs/ycql.md index e86c99464d95..82dd441e24eb 100644 --- a/docs/content/preview/drivers-orms/nodejs/ycql.md +++ b/docs/content/preview/drivers-orms/nodejs/ycql.md @@ -5,9 +5,9 @@ linkTitle: Connect an app description: Connect an application using YugabyteDB Node.js driver for YCQL menu: preview: - identifier: ycql-node-driver + identifier: node-driver-3-ycql parent: nodejs-drivers - weight: 600 + weight: 500 type: docs --- diff --git a/docs/content/preview/drivers-orms/nodejs/yugabyte-node-driver.md b/docs/content/preview/drivers-orms/nodejs/yugabyte-node-driver.md index 31f31ad5138f..6e3735fce3d4 100644 --- a/docs/content/preview/drivers-orms/nodejs/yugabyte-node-driver.md +++ b/docs/content/preview/drivers-orms/nodejs/yugabyte-node-driver.md @@ -5,7 +5,7 @@ linkTitle: Connect an app description: Connect an application using YugabyteDB Node.js smart driver for YSQL menu: preview: - identifier: yugabyte-node-driver + identifier: node-driver-1-yugabyte parent: nodejs-drivers weight: 500 type: docs @@ -105,7 +105,7 @@ postgresql://yugabyte:yugabyte@128.0.0.1:5433/yugabyte?loadBalance=true&ssl=true sslmode=verify-full&sslrootcert=~/.postgresql/root.crt ``` -Refer to [Configure SSL/TLS](../../../reference/drivers/nodejs/postgres-pg-reference/#configure-ssl-tls) for more information on default and supported SSL modes, and examples for setting up your connection strings when using SSL. +Refer to [Configure SSL/TLS](../postgres-pg-reference/#configure-ssl-tls) for more information on default and supported SSL modes, and examples for setting up your connection strings when using SSL. #### Use SSL with YugabyteDB Aeon @@ -220,7 +220,4 @@ If there is no output or you get an error, verify the parameters included in the ## Learn more -- Refer to [YugabyteDB node-postgres smart driver reference](../../../reference/drivers/nodejs/yugabyte-pg-reference/) and [Try it out](../../../reference/drivers/nodejs/yugabyte-pg-reference/#try-it-out) for detailed smart driver examples. -- [YugabyteDB smart drivers for YSQL](../../smart-drivers/) -- Build Node.js applications using [Sequelize ORM](../sequelize/) -- Build Node.js applications using [Prisma ORM](../prisma/) +[YugabyteDB smart drivers for YSQL](../../smart-drivers/) diff --git a/docs/content/preview/reference/drivers/nodejs/yugabyte-pg-reference.md b/docs/content/preview/drivers-orms/nodejs/yugabyte-pg-reference.md similarity index 93% rename from docs/content/preview/reference/drivers/nodejs/yugabyte-pg-reference.md rename to docs/content/preview/drivers-orms/nodejs/yugabyte-pg-reference.md index 964cedc9d3f4..c1a2500ebf64 100644 --- a/docs/content/preview/reference/drivers/nodejs/yugabyte-pg-reference.md +++ b/docs/content/preview/drivers-orms/nodejs/yugabyte-pg-reference.md @@ -3,13 +3,15 @@ title: YugabyteDB node-postgres Smart Driver reference headerTitle: Node.js Drivers linkTitle: Node.js Drivers description: YugabyteDB node-postgres smart driver for YSQL -headcontent: Node.js Drivers for YSQL +badges: ysql +aliases: +- /preview/reference/drivers/nodejs/yugabyte-pg-reference/ menu: preview: name: Node.js Drivers - identifier: ref-yugabyte-pg-driver - parent: drivers - weight: 500 + identifier: ref-1-yugabyte-pg-driver + parent: nodejs-drivers + weight: 100 type: docs --- @@ -30,12 +32,12 @@ type: docs -YugabyteDB node-postgres smart driver is a Node.js driver for [YSQL](../../../../api/ysql/) built on the [PostgreSQL node-postgres driver](https://github.com/brianc/node-postgres), with additional connection load balancing features. +YugabyteDB node-postgres smart driver is a Node.js driver for [YSQL](../../../api/ysql/) built on the [PostgreSQL node-postgres driver](https://github.com/brianc/node-postgres), with additional connection load balancing features. For more information on the YugabyteDB node-postgres smart driver, see the following: -- [YugabyteDB smart drivers for YSQL](../../../../drivers-orms/smart-drivers/) -- [CRUD operations](../../../../drivers-orms/nodejs/yugabyte-node-driver) +- [YugabyteDB smart drivers for YSQL](../../smart-drivers/) +- [CRUD operations](../yugabyte-node-driver) - [GitHub repository](https://github.com/yugabyte/node-postgres) - [Smart Driver architecture](https://github.com/yugabyte/yugabyte-db/blob/master/architecture/design/smart-driver.md) @@ -104,7 +106,7 @@ To use the driver, do the following: ## Try it out -This tutorial shows how to use the YugabyteDB node-postgres smart driver with YugabyteDB. It starts by creating a three-node cluster with a [replication factor](../../../../architecture/docdb-replication/replication/#replication-factor) of 3. This tutorial uses the [yb-ctl](../../../../admin/yb-ctl/#root) utility. +This tutorial shows how to use the YugabyteDB node-postgres smart driver with YugabyteDB. It starts by creating a three-node cluster with a [replication factor](../../../architecture/docdb-replication/replication/#replication-factor) of 3. This tutorial uses the [yb-ctl](../../../admin/yb-ctl/#root) utility. Next, you use a Node.js application to demonstrate the driver's load balancing features. diff --git a/docs/content/preview/drivers-orms/orms/rust/ysql-diesel.md b/docs/content/preview/drivers-orms/orms/rust/ysql-diesel.md index 7344a2db6fc0..7e2948ea973d 100644 --- a/docs/content/preview/drivers-orms/orms/rust/ysql-diesel.md +++ b/docs/content/preview/drivers-orms/orms/rust/ysql-diesel.md @@ -45,7 +45,7 @@ Build the REST API server (written using Diesel and Rocket) as follows: $ cargo build --release ``` -If you encounter a build failure, install [libpq](../../../../reference/drivers/ysql-client-drivers/#libpq) and try again. +If you encounter a build failure, install [libpq](../../ysql-client-drivers/#libpq) and try again. ## Set up the database connection diff --git a/docs/content/preview/drivers-orms/php/_index.md b/docs/content/preview/drivers-orms/php/_index.md index dd8d2fcae615..efcfbc96757e 100644 --- a/docs/content/preview/drivers-orms/php/_index.md +++ b/docs/content/preview/drivers-orms/php/_index.md @@ -34,3 +34,7 @@ To develop PHP applications for YugabyteDB, you need: - **a YugabyteDB cluster** - Create a free cluster on YugabyteDB Aeon. Refer to [Use a cloud cluster](../../quick-start-yugabytedb-managed/). Note that YugabyteDB Aeon requires SSL. - Alternatively, set up a standalone YugabyteDB cluster by following the steps in [Install YugabyteDB](../../quick-start/). + +## Next step + +[Connect an app](ysql/) diff --git a/docs/content/preview/drivers-orms/python/_index.md b/docs/content/preview/drivers-orms/python/_index.md index 01b26082a315..df417d3d9380 100644 --- a/docs/content/preview/drivers-orms/python/_index.md +++ b/docs/content/preview/drivers-orms/python/_index.md @@ -18,8 +18,8 @@ The following projects can be used to implement Python applications using the Yu | Project | Documentation and Guides | Latest Driver Version | Supported YugabyteDB Version | | ------- | ------------------------ | ------------------------ | ---------------------| -| Yugabyte Psycopg2 Smart Driver [Recommended] | [Documentation](yugabyte-psycopg2/)
[Reference](../../reference/drivers/python/yugabyte-psycopg2-reference/)| 2.9.3 | 2.8 and above | -| PostgreSQL Psycopg2 Driver | [Documentation](postgres-psycopg2/)
[Reference](../../reference/drivers/python/postgres-psycopg2-reference/) | 2.9.3 | 2.8 and above | +| Yugabyte Psycopg2 Smart Driver [Recommended] | [Documentation](yugabyte-psycopg2/)
[Reference](yugabyte-psycopg2-reference/)| 2.9.3 | 2.8 and above | +| PostgreSQL Psycopg2 Driver | [Documentation](postgres-psycopg2/)
[Reference](postgres-psycopg2-reference/) | 2.9.3 | 2.8 and above | | aiopg | [Documentation](aiopg/) | 1.4 | 2.8 and above | | YugabyteDB Python Driver for YCQL | [Documentation](ycql/) | [3.25.0](https://github.com/yugabyte/cassandra-python-driver/tree/master) | | @@ -30,13 +30,12 @@ The following projects can be used to implement Python applications using the Yu Learn how to establish a connection to a YugabyteDB database and begin basic CRUD operations by referring to [Connect an app](yugabyte-psycopg2/) or [Use an ORM](sqlalchemy/). -For reference documentation, including using projects with SSL, refer to the [drivers and ORMs reference](../../reference/drivers/python/yugabyte-psycopg2-reference/) pages. - ## Prerequisites To develop Python applications for YugabyteDB, you need the following: - **Python** + Ensure your system has Python3 installed. To check the version of Python installed, use the following command: ```sh @@ -46,9 +45,10 @@ To develop Python applications for YugabyteDB, you need the following: If not already installed, download and install it from the [Python Downloads](https://www.python.org/downloads/) page. - **YugabyteDB cluster** + - Create a free cluster on YugabyteDB Aeon. Refer to [Use a cloud cluster](../../quick-start-yugabytedb-managed/). Note that YugabyteDB Aeon requires SSL. - Alternatively, set up a standalone YugabyteDB cluster by following the steps in [Install YugabyteDB](../../quick-start/). ## Next step -- [Connect an app](yugabyte-psycopg2/) +[Connect an app](yugabyte-psycopg2/) diff --git a/docs/content/preview/drivers-orms/python/aiopg.md b/docs/content/preview/drivers-orms/python/aiopg.md index 925ba99a6d33..e58ba1ec1ee3 100644 --- a/docs/content/preview/drivers-orms/python/aiopg.md +++ b/docs/content/preview/drivers-orms/python/aiopg.md @@ -9,7 +9,7 @@ menu: preview: identifier: ysql-aiopg parent: python-drivers - weight: 571 + weight: 520 type: docs --- diff --git a/docs/content/preview/drivers-orms/python/django.md b/docs/content/preview/drivers-orms/python/django.md index 67a86764c7ee..a27a515bd661 100644 --- a/docs/content/preview/drivers-orms/python/django.md +++ b/docs/content/preview/drivers-orms/python/django.md @@ -7,7 +7,7 @@ menu: preview: identifier: django-orm parent: python-drivers - weight: 700 + weight: 600 type: docs --- -Psycopg is the most popular PostgreSQL database adapter for the Python programming language. Its main features are the complete implementation of the Python DB API 2.0 specification and the thread safety (several threads can share the same connection). YugabyteDB has full support for [Psycopg2](https://www.psycopg.org/). psycopg2 is based on libpq and supports the [SCRAM-SHA-256 authentication method](../../../../secure/authentication/password-authentication/#scram-sha-256). +Psycopg is the most popular PostgreSQL database adapter for the Python programming language. Its main features are the complete implementation of the Python DB API 2.0 specification and the thread safety (several threads can share the same connection). YugabyteDB has full support for [Psycopg2](https://www.psycopg.org/). psycopg2 is based on libpq and supports the [SCRAM-SHA-256 authentication method](../../../secure/authentication/password-authentication/#scram-sha-256). For details on using psycopg2, see [Psycopg documentation](https://www.psycopg.org/docs/). -For a tutorial on building a sample Python application that uses psycopg2, see [Connect an application](../../../../drivers-orms/python/postgres-psycopg2/). +For a tutorial on building a sample Python application that uses psycopg2, see [Connect an application](../postgres-psycopg2/). ## Fundamentals diff --git a/docs/content/preview/drivers-orms/python/postgres-psycopg2.md b/docs/content/preview/drivers-orms/python/postgres-psycopg2.md index 3b8f0fb74d22..6bc4c8d56cb8 100644 --- a/docs/content/preview/drivers-orms/python/postgres-psycopg2.md +++ b/docs/content/preview/drivers-orms/python/postgres-psycopg2.md @@ -7,7 +7,7 @@ menu: preview: identifier: postgres-psycopg2-driver parent: python-drivers - weight: 500 + weight: 510 type: docs --- @@ -215,8 +215,4 @@ Currently, [PostgreSQL psycopg2 driver](https://github.com/psycopg/psycopg2) and ## Learn more -- [PostgreSQL Psycopg2 driver reference](../../../reference/drivers/python/postgres-psycopg2-reference/) -- [YugabyteDB smart drivers for YSQL](../../smart-drivers/) -- Build Python applications using [YugabyteDB Psycopg2 smart driver](../yugabyte-psycopg2/) -- Build Python applications using [Django](../django/) -- Build Python applications using [SQLAlchemy](../sqlalchemy/) +[YugabyteDB smart drivers for YSQL](../../smart-drivers/) diff --git a/docs/content/preview/drivers-orms/python/sqlalchemy.md b/docs/content/preview/drivers-orms/python/sqlalchemy.md index 491c19bed18d..59761232d425 100644 --- a/docs/content/preview/drivers-orms/python/sqlalchemy.md +++ b/docs/content/preview/drivers-orms/python/sqlalchemy.md @@ -9,7 +9,7 @@ menu: preview: identifier: sqlalchemy-orm parent: python-drivers - weight: 600 + weight: 610 type: docs --- diff --git a/docs/content/preview/drivers-orms/python/ycql.md b/docs/content/preview/drivers-orms/python/ycql.md index 3ebf711c94ab..48dae70b8589 100644 --- a/docs/content/preview/drivers-orms/python/ycql.md +++ b/docs/content/preview/drivers-orms/python/ycql.md @@ -7,7 +7,7 @@ menu: preview: identifier: ycql-python-driver parent: python-drivers - weight: 600 + weight: 530 type: docs --- diff --git a/docs/content/preview/reference/drivers/python/yugabyte-psycopg2-reference.md b/docs/content/preview/drivers-orms/python/yugabyte-psycopg2-reference.md similarity index 91% rename from docs/content/preview/reference/drivers/python/yugabyte-psycopg2-reference.md rename to docs/content/preview/drivers-orms/python/yugabyte-psycopg2-reference.md index 8bda8b0e25fe..67698de254f3 100644 --- a/docs/content/preview/reference/drivers/python/yugabyte-psycopg2-reference.md +++ b/docs/content/preview/drivers-orms/python/yugabyte-psycopg2-reference.md @@ -3,15 +3,16 @@ title: YugabyteDB Psycopg2 Smart Driver headerTitle: Python Drivers linkTitle: Python Drivers description: YugabyteDB Psycopg2 Smart Driver for YSQL -headcontent: Python Drivers for YSQL +badges: ysql aliases: - /preview/reference/drivers/python/ + - /preview/reference/drivers/python/yugabyte-psycopg2-reference/ menu: preview: name: Python Drivers identifier: ref-yugabyte-psycopg2-driver - parent: drivers - weight: 650 + parent: python-drivers + weight: 100 type: docs --- @@ -30,12 +31,12 @@ type: docs -Yugabyte Psycopg2 smart driver is a Python driver for [YSQL](../../../../api/ysql/) built on the [PostgreSQL psycopg2 driver](https://github.com/psycopg/psycopg2), with additional connection load balancing features. +Yugabyte Psycopg2 smart driver is a Python driver for [YSQL](../../../api/ysql/) built on the [PostgreSQL psycopg2 driver](https://github.com/psycopg/psycopg2), with additional connection load balancing features. For more information on the YugabyteDB node-postgres smart driver, see the following: -- [YugabyteDB smart drivers for YSQL](../../../../drivers-orms/smart-drivers/) -- [CRUD operations](../../../../drivers-orms/python/yugabyte-psycopg2/) +- [YugabyteDB smart drivers for YSQL](../../smart-drivers/) +- [CRUD operations](../yugabyte-psycopg2/) - [GitHub repository](https://github.com/yugabyte/psycopg2) - [Smart Driver architecture](https://github.com/yugabyte/yugabyte-db/blob/master/architecture/design/smart-driver.md) @@ -87,7 +88,7 @@ To enable uniform load balancing across all servers, you set the `load-balance` conn = psycopg2.connect(user = 'username', password='password', host = 'hostname', port = '5433', dbname = 'database_name', load_balance='True') ``` -You can specify [multiple hosts](../../../../drivers-orms/go/yb-pgx/#use-multiple-addresses) in the connection string in case the primary address fails. After the driver establishes the initial connection, it fetches the list of available servers from the cluster, and load-balances subsequent connection requests across these servers. +You can specify [multiple hosts](../yugabyte-psycopg2/#use-multiple-addresses) in the connection string in case the primary address fails. After the driver establishes the initial connection, it fetches the list of available servers from the cluster, and load-balances subsequent connection requests across these servers. To specify topology keys, you set the `topology_keys` property to comma-separated values in the Connection string or dictionary, as per the following examples: @@ -117,7 +118,7 @@ conn = yb_pool.getconn() ## Try it out -This tutorial shows how to use the Yugabyte Psycopg2 driver with YugabyteDB. It starts by creating a 3 node cluster with a replication factor of 3. This tutorial uses the [yb-ctl](../../../../admin/yb-ctl/) utility. +This tutorial shows how to use the Yugabyte Psycopg2 driver with YugabyteDB. It starts by creating a 3 node cluster with a replication factor of 3. This tutorial uses the [yb-ctl](../../../admin/yb-ctl/) utility. Next, you use a Python shell terminal to demonstrate the driver's load balancing features by running a few python scripts. diff --git a/docs/content/preview/drivers-orms/python/yugabyte-psycopg2.md b/docs/content/preview/drivers-orms/python/yugabyte-psycopg2.md index 5e619cd4033c..5a5d78258665 100644 --- a/docs/content/preview/drivers-orms/python/yugabyte-psycopg2.md +++ b/docs/content/preview/drivers-orms/python/yugabyte-psycopg2.md @@ -7,7 +7,7 @@ menu: preview: identifier: yugabyte-psycopg2-driver parent: python-drivers - weight: 400 + weight: 500 type: docs --- @@ -272,8 +272,4 @@ Currently, [PostgreSQL psycopg2 driver](https://github.com/psycopg/psycopg2) and ## Learn more -- Refer to [YugabyteDB Psycopg2 driver reference](../../../reference/drivers/python/yugabyte-psycopg2-reference/) and [Try it out](../../../reference/drivers/python/yugabyte-psycopg2-reference/#try-it-out) for detailed smart driver examples. -- [YugabyteDB smart drivers for YSQL](../../smart-drivers/) -- Build Python applications using [PostgreSQL Psycopg2 smart driver](../postgres-psycopg2/) -- Build Python applications using [Django](../django/) -- Build Python applications using [SQLAlchemy](../sqlalchemy/) +[YugabyteDB smart drivers for YSQL](../../smart-drivers/) diff --git a/docs/content/preview/drivers-orms/ruby/_index.md b/docs/content/preview/drivers-orms/ruby/_index.md index a18aeba23472..b0facf883f5d 100644 --- a/docs/content/preview/drivers-orms/ruby/_index.md +++ b/docs/content/preview/drivers-orms/ruby/_index.md @@ -41,4 +41,4 @@ To develop Ruby applications for YugabyteDB, you need the following: ## Next step -- [Connect an app](ysql-pg) +[Connect an app](ysql-pg) diff --git a/docs/content/preview/drivers-orms/rust/_index.md b/docs/content/preview/drivers-orms/rust/_index.md index 17710697f534..3cd864b8805e 100644 --- a/docs/content/preview/drivers-orms/rust/_index.md +++ b/docs/content/preview/drivers-orms/rust/_index.md @@ -19,7 +19,7 @@ The following project is recommended for implementing Rust applications using th | Project | Documentation and Guides | Latest Driver Version | Supported YugabyteDB Version | Example Apps | | ------- | ------------------------ | --------------------- | ---------------------------- | ------------ | -| YugabyteDB Rust-Postgres Smart Driver [Recommended] | [Documentation](yb-rust-postgres/)
[Reference](../../reference/drivers/rust/rust-postgres-reference/) | [yb-postgres](https://crates.io/crates/yb-postgres) (synchronous YSQL client): v0.19.7-yb-1-beta
[yb-tokio-postgres](https://crates.io/crates/yb-tokio-postgres) (asynchronous YSQL client): v0.7.10-yb-1-beta | 2.19 and later +| YugabyteDB Rust-Postgres Smart Driver [Recommended] | [Documentation](yb-rust-postgres/)
[Reference](rust-postgres-reference/) | [yb-postgres](https://crates.io/crates/yb-postgres) (synchronous YSQL client): v0.19.7-yb-1-beta
[yb-tokio-postgres](https://crates.io/crates/yb-tokio-postgres) (asynchronous YSQL client): v0.7.10-yb-1-beta | 2.19 and later | | | Diesel | [Documentation](diesel/)
[Hello World](../orms/rust/ysql-diesel/) | | |[Diesel app](https://github.com/YugabyteDB-Samples/orm-examples/tree/master/rust/diesel) | Learn how to establish a connection to a YugabyteDB database and begin basic CRUD operations using the **Hello World** examples. @@ -30,15 +30,18 @@ For fully-runnable code snippets and explanations of common operations, see the To develop Rust applications for YugabyteDB, you need the following: -- **Rust**\ - To download and install Rust, refer to the [Rust](https://doc.rust-lang.org/cargo/getting-started/installation.html) documentation.\ +- **Rust** + + To download and install Rust, refer to the [Rust](https://doc.rust-lang.org/cargo/getting-started/installation.html) documentation. + To check the version of Rust, use the following command: ```sh $ rustc --version ``` -- **Create a Rust project**\ +- **Create a Rust project** + To create a new Rust project, run the following command: ```sh @@ -48,9 +51,10 @@ To develop Rust applications for YugabyteDB, you need the following: This creates the project as `HelloWorld-rust` which consists of a `Cargo.toml` file (project metadata) and a `src` directory containing the main code file, `main.rs`. - **YugabyteDB cluster** + - Create a free cluster on YugabyteDB Aeon. Refer to [Use a cloud cluster](../../quick-start-yugabytedb-managed/). Note that YugabyteDB Aeon requires SSL. - Alternatively, set up a standalone YugabyteDB cluster by following the steps in [Install YugabyteDB](../../quick-start/). ## Next step -- [Connect an app](yb-rust-postgres/) +[Connect an app](yb-rust-postgres/) diff --git a/docs/content/preview/reference/drivers/rust/rust-postgres-reference.md b/docs/content/preview/drivers-orms/rust/rust-postgres-reference.md similarity index 87% rename from docs/content/preview/reference/drivers/rust/rust-postgres-reference.md rename to docs/content/preview/drivers-orms/rust/rust-postgres-reference.md index 067018355bee..0af175540a58 100644 --- a/docs/content/preview/reference/drivers/rust/rust-postgres-reference.md +++ b/docs/content/preview/drivers-orms/rust/rust-postgres-reference.md @@ -3,17 +3,19 @@ title: YugabyteDB Rust Smart Driver headerTitle: Rust Drivers linkTitle: Rust Drivers description: Rust postgres Smart Driver for YSQL -headcontent: Rust Smart Driver for YSQL +badges: ysql +aliases: +- /preview/reference/drivers/rust/rust-postgres-reference/ menu: preview: name: Rust Drivers identifier: ref-rust-postgres-driver - parent: drivers - weight: 800 + parent: rust-drivers + weight: 100 type: docs --- -YugabyteDB Rust smart driver is a Rust driver for [YSQL](../../../../api/ysql/) based on [rust-postgres](https://github.com/sfackler/rust-postgres), with additional connection load balancing features. +YugabyteDB Rust smart driver is a Rust driver for [YSQL](../../../api/ysql/) based on [rust-postgres](https://github.com/sfackler/rust-postgres), with additional connection load balancing features. Rust smart drivers offers two different clients similar to rust-postgres: @@ -22,8 +24,8 @@ Rust smart drivers offers two different clients similar to rust-postgres: For more information on the YugabyteDB Rust smart driver, see the following: -- [YugabyteDB smart drivers for YSQL](../../../../drivers-orms/smart-drivers/) -- [CRUD operations](../../../../drivers-orms/rust/yb-rust-postgres/#crud-operations) +- [YugabyteDB smart drivers for YSQL](../../smart-drivers/) +- [CRUD operations](../yb-rust-postgres/#crud-operations) - [GitHub repository](https://github.com/yugabyte/rust-postgres) - [Smart Driver architecture](https://github.com/yugabyte/yugabyte-db/blob/master/architecture/design/smart-driver.md) @@ -57,8 +59,8 @@ Learn how to perform common tasks required for Rust application development usin The following connection properties need to be added to enable load balancing: -- `load_balance` - enable [cluster-aware load balancing](../../../../drivers-orms/smart-drivers/#cluster-aware-connection-load-balancing) by setting this property to true; disabled by default. -- `topology_keys` - provide comma-separated geo-location values to enable [topology-aware load balancing](../../../../drivers-orms/smart-drivers/#topology-aware-connection-load-balancing). Geo-locations can be provided as `cloud.region.zone`. Specify all zones in a region as `cloud.region.*`. To designate fallback locations for when the primary location is unreachable, specify a priority in the form `:n`, where `n` is the order of precedence. For example, `cloud1.datacenter1.rack1:1,cloud1.datacenter1.rack2:2`. +- `load_balance` - enable [cluster-aware load balancing](../../smart-drivers/#cluster-aware-connection-load-balancing) by setting this property to true; disabled by default. +- `topology_keys` - provide comma-separated geo-location values to enable [topology-aware load balancing](../../smart-drivers/#topology-aware-connection-load-balancing). Geo-locations can be provided as `cloud.region.zone`. Specify all zones in a region as `cloud.region.*`. To designate fallback locations for when the primary location is unreachable, specify a priority in the form `:n`, where `n` is the order of precedence. For example, `cloud1.datacenter1.rack1:1,cloud1.datacenter1.rack2:2`. By default, the driver refreshes the list of nodes every 300 seconds (5 minutes). You can change this value by including the `yb_servers_refresh_interval` parameter. @@ -79,7 +81,7 @@ let url: String = String::from( "postgresql://localhost:5434/yugabyte?user=yugab let conn = yb_postgres::Client::connect(&connection_url,NoTls,)?; ``` -You can specify [multiple hosts](../../../../drivers-orms/rust/yb-rust-postgres/#use-multiple-addresses) in the connection string to use as fallbacks in case the primary address fails during the initial connection attempt. After the driver establishes the initial connection, it fetches the list of available servers from the cluster, and load-balances subsequent connection requests across those servers. +You can specify [multiple hosts](../yb-rust-postgres/#use-multiple-addresses) in the connection string to use as fallbacks in case the primary address fails during the initial connection attempt. After the driver establishes the initial connection, it fetches the list of available servers from the cluster, and load-balances subsequent connection requests across those servers. To specify topology keys, you set the `topology_keys` property to comma-separated values in the connection string or dictionary, as per the following example: @@ -90,11 +92,11 @@ let conn = yb_postgres::Client::connect(&connection_url,NoTls,)?; ## Try it out -This tutorial shows how to use the asynchronous yb-tokio-postgres client with YugabyteDB. It starts by creating a three-node cluster with a [replication factor](../../../../architecture/docdb-replication/replication/#replication-factor) of 3. This tutorial uses the [yugabyted](../../../configuration/yugabyted/) utility. +This tutorial shows how to use the asynchronous yb-tokio-postgres client with YugabyteDB. It starts by creating a three-node cluster with a [replication factor](../../../architecture/docdb-replication/replication/#replication-factor) of 3. This tutorial uses the [yugabyted](../../../reference/configuration/yugabyted/) utility. Next, you use a Rust application to demonstrate the driver's load balancing features. -For an example using the synchronous yb-postgres client, see [Connect an application](../../../../drivers-orms/rust/yb-rust-postgres). +For an example using the synchronous yb-postgres client, see [Connect an application](../yb-rust-postgres). ### Create a local cluster @@ -353,7 +355,7 @@ The following is an example connection URL for connecting to a YugabyteDB cluste "postgresql://127.0.0.1:5434/yugabyte?user=yugabyte&password=yugabyte&load_balance=true&sslmode=require" ``` -If you created a cluster on [YugabyteDB Aeon](../../../../yugabyte-cloud/), use the cluster credentials and download the [SSL Root certificate](../../../../yugabyte-cloud/cloud-secure-clusters/cloud-authentication/#download-your-cluster-certificate). +If you created a cluster on [YugabyteDB Aeon](../../../yugabyte-cloud/), use the cluster credentials and download the [SSL Root certificate](../../../yugabyte-cloud/cloud-secure-clusters/cloud-authentication/#download-your-cluster-certificate). The following is an example application for connecting to a YugabyteDB cluster with SSL enabled: diff --git a/docs/content/preview/drivers-orms/rust/yb-rust-postgres.md b/docs/content/preview/drivers-orms/rust/yb-rust-postgres.md index 75fda244d021..1916610ed7eb 100644 --- a/docs/content/preview/drivers-orms/rust/yb-rust-postgres.md +++ b/docs/content/preview/drivers-orms/rust/yb-rust-postgres.md @@ -8,7 +8,7 @@ menu: preview: identifier: rust-postgres-driver parent: rust-drivers - weight: 600 + weight: 500 type: docs --- diff --git a/docs/content/preview/reference/drivers/ycql-client-drivers.md b/docs/content/preview/drivers-orms/ycql-client-drivers.md similarity index 86% rename from docs/content/preview/reference/drivers/ycql-client-drivers.md rename to docs/content/preview/drivers-orms/ycql-client-drivers.md index c30dbc43935f..d177a8eaee9a 100644 --- a/docs/content/preview/reference/drivers/ycql-client-drivers.md +++ b/docs/content/preview/drivers-orms/ycql-client-drivers.md @@ -1,18 +1,25 @@ --- title: Client drivers for YCQL API headerTitle: Client drivers for YCQL -linkTitle: Client drivers for YCQL +linkTitle: Additional drivers description: Lists the client drivers that you can use to build and access YCQL applications. +badges: ycql +aliases: + - /preview/reference/drivers/ycql-client-drivers/ menu: preview: identifier: ycql-client-libraries - parent: drivers - weight: 2942 -aliases: + parent: drivers-orms + weight: 2001 type: docs --- -The following client drivers are supported for use with the [YugabyteDB Cloud Query Language (YCQL) API](../../../api/ycql/), a SQL-based, semi-relational API, with roots in the Apache Cassandra Query Language (CQL). +{{
-
-
-
-
-
-
diff --git a/docs/content/preview/releases/versioning.md b/docs/content/preview/releases/versioning.md
index c25d65668ec2..e351e84e0635 100644
--- a/docs/content/preview/releases/versioning.md
+++ b/docs/content/preview/releases/versioning.md
@@ -98,6 +98,10 @@ TP features aren't supported by Customer Support and may change at any time duri
If you are interested in a TP feature, contact {{% support-general %}}.
+{{
- 
- 
- 
- 
- 
- 
-