跳到主要内容
版本：V1.1.0

SeekdbClient

SeekdbClient 用于连接 seekdb 的统一接口,支持 seekdb Server 模式和 OceanBase 模式。

提示

OceanBase 数据库是 OceanBase 提供的一款完全自研的企业级原生分布式数据库，在普通硬件上实现金融级高可用，首创“三地五中心”城市级故障自动无损容灾新标准，刷新 TPC-C 标准测试，单集群规模超过 1500 节点，具有云原生、强一致性、高度兼容 Oracle/MySQL 等特性。有关 OceanBase 数据库的更多信息，参见 OceanBase 数据库。

连接远程服务器​

通过 SeekdbClient 连接到远程服务器，支持连接到 seekdb 和 OceanBase 数据库。

提示

连接之前，请确保您已经部署了服务器模式的 seekdb 或者 OceanBase 数据库。
有关服务器模式 seekdb 的部署方法，参见 通过 yum install 部署 seekdb。
有关 OceanBase 数据库的部署方法，参见 部署概述。

示例：连接到服务器模式的 seekdb

import { SeekdbClient } from "seekdb";

// 1. Connect
const client = new SeekdbClient({
  host: "127.0.0.1",
  port: 2881,
  user: "root",
  password: "",
  database: "test",
});

参数说明：

参数取值类型是否必选描述取值示例
hoststring必选实例所在服务器 IP。127.0.0.1
portstring必选实例端口。默认为 2881。2881
databasestring必选数据库名。test
userstring必选用户名。默认为 root。root
passwordstring必选用户所对应的密码。如果未提供 password 或者填写了空字符串，系统会通过 SEEKDB_PASSWORD 环境变量获取。

示例：连接到 OceanBase 数据库

import { SeekDBClient } from "seekdb";

const client = new SeekDBClient({
  host: "127.0.0.1",      // 服务器地址
  port: 2881,              // 服务器端口
  tenant: "sys",          // 租户名称 (适用于连接 OceanBase 数据库)
  database: "demo",       // 数据库名称
  user: "root",           // 用户名
  password: "",           // 密码
});

参数说明：

参数取值类型是否必选描述取值示例
hoststring必选数据库所在服务器 IP。127.0.0.1
portstring必选OceanBase 数据库端口。默认为 2881。2881
tenantstring可选租户名。seekdb 是不需要写这个参数的，只有 OceanBase 数据库的时候需要，默认是 sys。sys
databasestring必选数据库名。demo
userstring必选租户对应的用户名。默认为 root。root
passwordstring必选用户所对应的密码。

使用 SeekdbClient 进行连接所支持的接口​

当使用 SeekdbClient 连接数据库时，支持使用以下 API 接口。

API 接口描述相关文档链接
createCollection()创建一个新的 collection。文档
getCollection()查询指定的 collection。文档
getOrCreateCollection()查询指定的 collection，如果该 collection 不存在则会创建该 collection。文档
fork()复制指定的 Collection，以创建具有相同数据的新 Collection。文档
listCollections()列出当前数据库中全部的 collections。文档
countCollection()查询当前数据库中所有 collection 的数量。文档
hasCollection()检查当前数据库中的 collections 是否存在。文档
deleteCollection()删除指定的 collection。文档

Contents

编辑此页