Quick start

seekdb-js

seekdb-js is a node client provided by OceanBase Database. It allows you to connect to a remote server (in server mode) or OceanBase Database through a set of APIs.

tip

OceanBase Database is a fully self-developed enterprise-level native distributed database independently developed by OceanBase. It achieves financial-grade high availability on general-purpose hardware. It sets a new standard for automatic lossless disaster recovery across three regions with five IDCs. It also sets a new benchmark in the TPC-C standard test with a single cluster size exceeding 1,500 nodes. OceanBase Database is cloud-native, highly consistent, and highly compatible with Oracle and MySQL. For more information about OceanBase Database, see OceanBase Database.

Install seekdb-js

Prerequisites

Make sure that your environment meets the following requirements:

• Node.js 20 or later

• The server mode of seekdb has been deployed and started. For more information about how to deploy the server mode of seekdb, see Deploy seekdb by using yum install.

Procedure

npm install seekdb

What to do next

• After you install seekdb-js, you can connect to seekdb to perform operations. For more information about the APIs supported by seekdb-js, see API reference.

• You can also refer to our SDK samples to quickly get started with seekdb-js.

  • Simple example

  • Complete example

  • Hybrid search example