编程语言接入

本文档介绍了如何使用编程语言连接 YMatrix 并进行查询。将给出高可用连接与非高可用连接两种方式。

高可用指的是 YMatrix 的故障自动转移机制，主节点（Master）发生故障后，由主节点备用节点（Standby）对外提供服务。

高可用连接是指 YMatrix 发生故障自动转移后，程序自动连接到故障转移后的节点。

高可用连接字符串（Connection URLs / DSN）提供了一种标准化的格式，可以在不同的应用程序中使用，而无需重新输入完整的连接信息。
它通常由多个字段组成，每个字段表示不同的连接信息，例如：
postgres://username:password@master_ip:master_port,standby_ip:standby_port/database?sslmode=disable

其中：

username 和 password 分别是登录数据库的用户名和密码。
master_ip:master_port 与 standby_ip:standby_port 为 Master 和 Standby 的连接信息。
database 表示要连接的数据库名。
sslmode 表示是否启用 SSL 连接。

注意！
YMatrix 支持通过 MatrixGate API 接口高速写入数据，详见编程语言写入 MatrixGate。

创建示例用户 ymatrix，密码为 1234。

=# CREATE USER ymatrix PASSWORD '1234';

Master IP：172.16.100.81；Port：5432
Standby IP：172.16.100.82；Port：5432
Database：ymatrixdb

1 JAVA（高可用）

推荐使用官方的驱动 PostgreSQL JDBC Driver 作为数据库连接驱动程序。

package com.postgresqltutorial;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.SQLException;
public class App{
    private final String url = "jdbc:postgres://ymatrix:1234@172.16.100.81:5432,172.16.100.82:5432/ymatrixdb?sslmode=disable"; 
    private final String user = "ymatrix";
    private final String password = "1234";
    /**
     * Connect to the YMatrix database
     *
     * @return a Connection object
     */
    public Connection connect() {
        Connection conn = null;
        try {
            conn = DriverManager.getConnection(url, user, password);
            System.out.println("Connected to the YMatrix server successfully.");
        } catch (SQLException e) {
            System.out.println(e.getMessage());
        }
        return conn;
    }
    /**
     * @param args the command line arguments
     */
    public static void main(String[] args) {
        App app = new App();
        app.connect();
    }
}

2 Python（高可用）

推荐使用 psycopg 2/3 作为数据库连接驱动程序。

# -*- coding: utf-8 -*-
import psycopg2

class YMatrix(object):
    def __init__(self):
        self.dsn = "postgres://ymatrix:1234@172.16.100.81:5432,172.16.100.82:5432/ymatrixdb?sslmode=disable"

    def get_conn(self):
        conn = psycopg2.connect(dsn=self.dsn)
        return conn

    def create_table(self):
        conn = self.get_conn()
        cursor = conn.cursor()
        sql = "CREATE TABLE data(" \
              "time timestamp," \
              "tag_id int," \
              "metrics1 float8," \
              "metrics2 float8," \
              "metrics3 float8" \
              ")USING MARS3" \
              "DISTRIBUTED BY (tag_id)" \
              "ORDER BY (tag_id)"
        cursor.execute(sql)
        conn.commit()
        conn.close()

    def insert(self):
        conn = self.get_conn()
        cursor = conn.cursor()
        sql = "INSERT INTO data VALUES(now(), 1, 1.1, 1.2, 1.3)"
        cursor.execute(sql)
        conn.commit()
        conn.close()

    def select(self):
        conn = self.get_conn()
        cursor = conn.cursor()
        sql = "SELECT * FROM data"
        cursor.execute(sql)
        data = cursor.fetchone()
        conn.commit()
        conn.close()
        return data

if __name__ == '__main__':
    mxdb = YMatrix()
    mxdb.create_table()
    mxdb.insert()
    print(mxdb.select())

3 Golang（高可用）

推荐使用 pgx 作为数据库连接驱动程序。

package main

import (
    "context"
    "fmt"
    "github.com/jackc/pgx/v4"
)

func main() {
    // 构建连接配置
    dsn := "postgres://ymatrix:<password>@172.16.100.81:5432,172.16.100.82:5432/ymatrixdb?sslmode=disable"
    config, err := pgx.ParseConfig(dsn)
    if err != nil {
        fmt.Println("Unable to parse config:", err)
        return
    }
    // 连接数据库
    conn, err := pgx.ConnectConfig(context.Background(), config)
    if err != nil {
        fmt.Println("Unable to connect to database:", err)
        return
    }
    defer conn.Close(context.Background())
}

4 Ruby（高可用）

推荐使用 ruby-pg 作为数据库连接驱动程序并与 postgresql 12 的 headers 共同编译。

require 'pg'
# 构建连接配置
dsn = "postgres://ymatrix:1234@172.16.100.81:5432,172.16.100.82:5432/ymatrixdb?sslmode=disable"
conn = PG.connect(dsn)
# 执行数据库操作
begin
  conn.exec('SELECT * FROM table_name') do |result|
    result.each do |row|
      # 处理每一行数据
      puts row.inspect
    end
  end
rescue PG::Error => e
  puts "执行数据库操作时发生错误：#{e.message}"
ensure
  # 关闭数据库连接
  conn.close if conn
end

5 Rust（高可用）

推荐使用 rust-postgres 作为数据库连接驱动程序。

use postgres::{Client, Error, NoTls};
fn main() -> Result<(), Error> {
    let mut client = Client::connect(
        "postgresql://ymatrix:1234@172.16.100.81:5432,172.16.100.82:5432/ymatrixdb",
        NoTls,
    )?;
    for row in client.query("SELECT * FROM table_name", &[])? {
        let id: i32 = row.get(0);
        let name: String = row.get(1); 
        println!("ID: {}, Name: {}", id, name);
        // 在这里可以进行你需要的数据处理操作
    }
    Ok(())
}

6 C#（高可用）

推荐使用 npgsql 作为数据库连接驱动程序。

C#
using System;
using Npgsql;
class Program
{
    static void Main()
    {
        // 配置高可用 DSN
        var connectionString = "Host=sdw1, sdw2;Port=5432;Database=mydatabase;Username=myuser;Password=mypassword;Load Balance Hosts=true";
        // 创建数据库连接
        using var connection = new NpgsqlConnection(connectionString);
        try
        {
            // 打开数据库连接
            connection.Open();
            // 执行数据库操作
            using var command = new NpgsqlCommand("SELECT * FROM table_name", connection);
            using var reader = command.ExecuteReader();
            // 处理查询结果
            while (reader.Read())
            {
                // 处理每一行数据
                var column1Value = reader.GetString(0);
                var column2Value = reader.GetInt32(1);
                Console.WriteLine($"{column1Value}, {column2Value}");
            }
        }
        catch (Exception ex)
        {
            Console.WriteLine($"An error occurred: {ex.Message}");
        }
    }
}

7 C / C++（高可用）

推荐使用 ODBC 作为数据库连接驱动程序。

注意！
以下命令均需要使用 root 用户或通过 sudo 权限执行。

下载并安装 ODBC。

# yum install -y unixODBC.x86_64
# yum install -y postgresql-odbc.x86_64

编辑 ODBC 相关文件。

# cat /usr/local/etc/odbcinst.ini
[PostgreSQL]
Description = ODBC for PostgreSQL
Driver      = /usr/lib/psqlodbcw.so
Setup       = /usr/lib/libodbcpsqlS.so
Driver64    = /usr/lib64/psqlodbcw.so
Setup64     = /usr/lib64/libodbcpsqlS.so
FileUsage = 1

# cat /usr/local/etc/odbc.ini
[pg]
Description = Test to pg
Driver = PostgreSQL
Database = test
// “<>” 内内容需替换为实际集群信息，并去掉 “<>” 符号
Servername = <Master,Standby>
UserName = mxadmin
Password = mxadmin
Port = <Master Port,Standby Port>
ReadOnly = 0

编辑 C/C++ 相关文件。

# cat test.c

#include <stdio.h>
#include <sql.h>
#include <sqlext.h>
#include <string.h>
#include <sqltypes.h>

int main()
{
    SQLHENV henv;
    SQLHDBC hdbc;
    SQLHSTMT hstmt;
    SQLRETURN ret;

    // 分配环境句柄
    ret = SQLAllocHandle(SQL_HANDLE_ENV, SQL_NULL_HANDLE, &henv);
    // 设置环境属性
    ret = SQLSetEnvAttr(henv, SQL_ATTR_ODBC_VERSION, (SQLPOINTER)SQL_OV_ODBC3, 0);
    // 分配连接句柄
    ret = SQLAllocHandle(SQL_HANDLE_DBC, henv, &hdbc);
    // 连接到数据库
    ret = SQLConnect(hdbc, "pg", SQL_NTS, "mxadmin", SQL_NTS, "mxadmin", SQL_NTS);
    if (ret == SQL_SUCCESS || ret == SQL_SUCCESS_WITH_INFO)
    {
        printf("Connected to PostgreSQL database successfully.\n");

        // 创建表，需将 <tablename> 替换为实际信息
        ret = SQLAllocHandle(SQL_HANDLE_STMT, hdbc, &hstmt);
        ret = SQLExecDirect(hstmt, "CREATE TABLE <tablename> (id int) USING MARS3 DISTRIBUTED BY (id) ORDER BY (id)", SQL_NTS);
        if (ret == SQL_SUCCESS || ret == SQL_SUCCESS_WITH_INFO)
        {
                printf("成功创建表<tablename>.\n");
        }
        // 断开数据库连接
        SQLDisconnect(hdbc);
    }
    else
    {
        printf("Failed to connect to PostgreSQL database.\n");
    }
    // 释放句柄
    SQLFreeHandle(SQL_HANDLE_STMT, hstmt);
    SQLFreeHandle(SQL_HANDLE_DBC, hdbc);
    SQLFreeHandle(SQL_HANDLE_ENV, henv);

    return 0;
}

编译。

# gcc -lodbc -o test test.c

运行。

# ./test 
Connected to PostgreSQL database successfully.

确认表已成功创建。

=#  \d <tablename>
              Table "public.test2"
 Column |  Type   | Collation | Nullable | Default 
--------+---------+-----------+----------+---------
 id     | integer |           |          | 
Distributed by: (id)

8 NodeJS（高可用）

推荐使用 postgres 模块作为数据库连接驱动程序。

const postgres = require('postgres')

async function query() {
  // 创建高可用数据库连接
  const conn = postgres(`postgres://username:password@master,stanby:port/database?sslmode=disable`)
  try {
    // 执行查询 SQL
    const rows = await conn`SELECT id, name FROM users`
    rows.forEach(row => {
      console.log(`id: ${row.id}, name: ${row.name}`)
    })
  } catch (err) {
    console.error(err)
  } finally {
    // 关闭连接
    await conn.end()
  }
}

query()