psycopg2-yugabytedb-binary 2.9.3.2b0

文档

文档包含在 doc 目录中，并且可在网上找到，链接为 https://www.psycopg.org/docs/。

对于任何其他资源（源代码仓库、错误跟踪器、邮件列表），请检查 项目主页。

安装

构建 Psycopg 需要一些先决条件（一个 C 编译器、一些开发包）：请查阅 doc 目录或在线的 安装 和 常见问题解答 文档以获取详细信息。

如果满足先决条件，您可以使用 pip 安装 psycopg，就像安装任何其他 Python 包一样，从 PyPI 下载

$ pip install psycopg2-yugabytedb

或者如果您已下载本地源代码包，可以使用 setup.py

$ python setup.py build
$ sudo python setup.py install

注意 - YugabyteDB Psycopg2 需要 PostgreSQL 版本 11 或更高版本（最好是 14）

您还可以通过从 PyPI 安装 psycopg2-yugabytedb-binary 包来获取不要求编译器或外部库的独立 Windows 包

$ pip install psycopg2-yugabytedb-binary

Linux/OSX：

Windows：

负载均衡

Yugabyte Psycopg2 驱动程序具有以下负载均衡功能

• 均匀负载均衡

在此模式下，驱动程序尽力将连接均匀分布到每个 YugabyteDB 服务器。例如，如果客户端应用程序创建 100 个连接到由 10 个服务器组成的 YugabyteDB 集群，则驱动程序将为每个服务器创建 10 个连接。如果连接数不能被服务器数整除，则其中一些可能比其他的多或少一个连接。这是客户端对负载的看法，因此如果其他客户端应用程序没有使用 Yugabyte JDBC 驱动程序，服务器可能不会得到很好的平衡。

• 拓扑感知负载均衡

由于 YugabyteDB 集群可以在不同的地区和可用区拥有服务器，因此 YugabyteDB JDBC 驱动程序是拓扑感知的，并且可以配置为仅在特定地区和可用区的服务器上创建连接。这对于需要连接到地理位置最近的地区和可用区以降低延迟的客户端应用程序很有用；驱动程序仅尝试均匀负载指定地区和区域的那些服务器。Yugabyte Psycopg2 驱动程序也可以配置为使用连接池。

用法

负载均衡连接属性

以下连接属性需要添加以启用负载均衡

• load_balance - 通过将此属性设置为 True 启用集群感知负载均衡；默认情况下禁用。

• topology_keys - 提供逗号分隔的地理位置值以启用拓扑感知负载均衡。地理位置可以作为 cloud.region.zone 提供。

• yb-servers-refresh-interval - 默认情况下，用于平衡连接负载的服务器列表每 5 分钟刷新一次。此时间可以通过此属性进行调节。

在连接 URL 或字典中传递新的连接属性以进行负载均衡。要启用所有服务器上的均匀负载均衡，您可以在 URL 中将 load-balance 属性设置为 True，如下例所示。

连接字符串

conn = psycopg2.connect("dbname=database_name host=hostname port=port user=username  password=password load_balance=true")

连接字典

conn = psycopg2.connect(user = 'username', password='xxx', host = 'hostname', port = 'port', dbname = 'database_name', load_balance='True')

要指定拓扑键，您可以将 topology_keys 属性设置为逗号分隔的值，如下例所示。

连接字符串

conn = psycopg2.connect("dbname=database_name host=hostname port=port user=username  password=password load_balance=true topology_keys=cloud1.region1.zone1,cloud2.region2.zone2")

连接字典

conn = psycopg2.connect(user = 'username', password='xxx', host = 'hostname', port = 'port', dbname = 'database_name', load_balance='True', topology_keys='cloud1.region1.zone1,cloud2.region2.zone2')

多个拓扑结构也可以传递给“拓扑键”属性，并且每个都可以分配一个优先级值，如下例所示。

conn = psycopg2.connect("host=127.0.0.1 port=5433 user=yugabyte dbname=yugabyte load_balance=True topology_keys=cloud1.region1.zone1:1,cloud2.region2.zone2:2")

优先级值（在冒号后附加）是可选的。因此，它与指定云位置的先前语法兼容。

优先级值 :1 表示主要放置区域，值 :2 表示第一次回退，值 :3 表示第二次回退，依此类推。