Skip to main content
Version: V1.3.0

Quick start

pyseekdb​

pyseekdb is OceanBase's Python client for seekdb. It exposes one API surface and supports two database connection modes: embedded seekdb, and a remote server (server-mode seekdb or OceanBase Database).

tip

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

pyseekdb is supported on Linux, macOS, and Windows. The supported database connection modes vary by operating system. For more information, see the table below.

SystemEmbedded seekdbServer mode seekdbServer mode OceanBase Database
LinuxSupportedSupportedSupported
macOSSupportedSupportedSupported
WindowsNot supported yetSupportedSupported

On Linux and macOS, installing this client also installs embedded seekdb, so you can connect directly to embedded seekdb to create databases and perform other operations. You can also connect remotely to an existing server-mode seekdb or OceanBase Database.

Install pyseekdb​

Prerequisites​

Ensure your environment meets the following requirements:

  • Operating system: Linux (glibc >= 2.28), macOS, Windows
  • Python version: Python 3.11 or later
  • System architecture: x86_64, aarch64

Install​

Use pip to install. It automatically detects the default Python version and platform.

pip install -U pyseekdb

If your pip version is low, upgrade pip before you install.

pip install --upgrade pip

Next steps​

Contents

Edit this page