YugabyteDB Python应用开发实战教程：使用YSQL API构建分布式应用-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00005/article/details/148419216

YugabyteDB Python应用开发实战教程：使用YSQL API构建分布式应用

yugabyte-db yugabyte/yugabyte-db: 是 YugaByte DB 的官方仓库，一个高性能、高可扩展、分布式的 SQL 数据库，支持 PostgreSQL 兼容性。适合对分布式数据库、SQL 数据库和云原生应用的开发者。项目地址: https://gitcode.com/gh_mirrors/yu/yugabyte-db

前言

在分布式数据库领域，YugabyteDB作为一款高性能、云原生的分布式SQL数据库，提供了与PostgreSQL兼容的YSQL API。本教程将详细介绍如何使用Python语言和psycopg2驱动构建一个基于YugabyteDB的应用程序。

环境准备

系统要求

Python 3.6或更高版本（如果是Apple Silicon芯片的Mac设备，需要Python 3.9.7+）
psycopg2-binary包（PostgreSQL Python适配器）
可访问的YugabyteDB集群（本地或云端）

获取示例代码

建议从官方示例库获取基础代码模板，这包含了完整的项目结构和基础实现。

配置数据库连接

连接YugabyteDB集群需要正确配置以下参数：

config = {
    'host': '集群主机地址',
    'port': 5433,  # 默认YSQL端口
    'dbName': 'yugabyte',  # 默认数据库
    'dbUser': '数据库用户名',
    'dbPassword': '数据库密码',
    'sslMode': 'verify-full',  # 云端集群必须使用SSL
    'sslRootCert': '/path/to/root.crt'  # CA证书路径
}

重要说明：对于云端部署的YugabyteDB集群，SSL连接是强制要求的，这是保障数据传输安全的重要措施。

应用架构解析

1. 数据库连接管理

核心连接逻辑使用psycopg2的connect方法，支持SSL和非SSL两种连接方式：

import psycopg2

def create_connection(config):
    try:
        if config['sslMode']:
            conn = psycopg2.connect(
                host=config['host'],
                port=config['port'],
                database=config['dbName'],
                user=config['dbUser'],
                password=config['dbPassword'],
                sslmode=config['sslMode'],
                sslrootcert=config['sslRootCert'],
                connect_timeout=10
            )
        else:
            conn = psycopg2.connect(
                host=config['host'],
                port=config['port'],
                database=config['dbName'],
                user=config['dbUser'],
                password=config['dbPassword'],
                connect_timeout=10
            )
        return conn
    except Exception as e:
        print(f"数据库连接失败: {e}")
        raise

2. 数据表创建与初始化

示例中创建了一个简单的银行账户表：

def init_database(conn):
    try:
        with conn.cursor() as cursor:
            # 删除已存在的表（如果存在）
            cursor.execute('DROP TABLE IF EXISTS DemoAccount')
            
            # 创建新表
            create_table_sql = """
            CREATE TABLE DemoAccount (
                id int PRIMARY KEY,
                name varchar,
                age int,
                country varchar,
                balance int
            )"""
            cursor.execute(create_table_sql)
            
            # 插入初始数据
            insert_sql = """
            INSERT INTO DemoAccount VALUES
                (1, 'Jessica', 28, 'USA', 10000),
                (2, 'John', 28, 'Canada', 9000)"""
            cursor.execute(insert_sql)
        conn.commit()
    except Exception as e:
        conn.rollback()
        print(f"数据库初始化失败: {e}")
        raise

3. 数据查询操作

使用RealDictCursor可以获取字段名和值的字典形式结果：

def query_accounts(conn):
    try:
        with conn.cursor(cursor_factory=psycopg2.extras.RealDictCursor) as cursor:
            cursor.execute("""
                SELECT name, age, country, balance 
                FROM DemoAccount
            """)
            for row in cursor.fetchall():
                print(
                    f"name = {row['name']}, "
                    f"age = {row['age']}, "
                    f"country = {row['country']}, "
                    f"balance = {row['balance']}"
                )
    except Exception as e:
        print(f"查询失败: {e}")
        raise

4. 分布式事务处理

YugabyteDB支持ACID事务，以下示例展示转账操作：

def transfer_funds(conn, from_name, to_name, amount):
    try:
        with conn.cursor() as cursor:
            # 扣减转出账户余额
            cursor.execute("""
                UPDATE DemoAccount 
                SET balance = balance - %s 
                WHERE name = %s
            """, (amount, from_name))
            
            # 增加转入账户余额
            cursor.execute("""
                UPDATE DemoAccount 
                SET balance = balance + %s 
                WHERE name = %s
            """, (amount, to_name))
            
        conn.commit()
    except psycopg2.DatabaseError as e:
        conn.rollback()
        if e.pgcode == '40001':  # 事务冲突错误码
            print("事务冲突：检测到并发修改，建议添加重试逻辑")
        else:
            print(f"转账操作失败: {e}")
        raise