Skip to content

kingbasees.mdx

Latest commit

 

History

History
86 lines (58 loc) · 3.85 KB

kingbasees.mdx

File metadata and controls

86 lines (58 loc) · 3.85 KB
Raw
title KingbaseES
description Connect to a KingbaseES server with the downloadable libpq driver

import RegistryPlugin from "/snippets/registry-plugin.mdx";

Choose KingbaseES when creating the connection. Enter the database and role supplied by your administrator; neither field is pre-filled.

The plugin is named KingbaseES Driver. It supports KingbaseES V9 and was tested against V9R1C10 in PostgreSQL and Oracle compatibility modes.

Quick setup

Create a connection, choose **KingbaseES**, and install its driver when offered. Set **Host**, **Port**, **Username**, **Password**, and **Database** to the values for your server. The default port is `54321`. Click **Save & Connect**.

Connection settings

Field Default Notes
Host localhost Enter the server hostname or IP address
Port 54321 Use the port configured on your server
Username Empty Enter your database role
Database Empty Required; enter the database to open
SSL Mode Preferred Tries TLS first, then plain text if the server refuses TLS
Connection Options Empty Additional libpq connection options

Connection URL

kingbase://user:password@host:54321/database
kingbase8://user:password@host:54321/database

See Connection URL Reference for opening a connection URL.

Authentication

Enter the password for your database role, or select Use ~/.pgpass to read it from a password file. A matching entry uses the server's port:

host:54321:database:user:password

Set the file permissions with chmod 0600 ~/.pgpass. See Password file.

Cross-database tabs

Each database opened from the connections strip keeps a separate connection. A tab runs on the connection for its bound database; transactions and temporary tables belong to that connection. See Cross-database tabs.

Compatibility modes

The driver reads the server's database_mode setting when it connects. PostgreSQL (pg) and Oracle (oracle) modes are supported. A server in MySQL or SQL Server mode is refused with an error, and a server without the setting connects in PostgreSQL mode.

In Oracle mode, anonymous blocks, procedure bodies, q'[...]' strings and / lines stay whole when you run a statement or a script, import a .sql file, or run startup commands. Dollar-quoted strings work in both modes.

Copying and comparing

Copy tables between KingbaseES in PostgreSQL mode and PostgreSQL, or generate a Compare & Sync structure script between them. A server in Oracle mode spells its column types its own way, so it copies and syncs structure only with another Oracle-mode server. See Copy objects and Compare & Sync.

SSL/TLS

The default Preferred mode falls back to plain text when the server refuses TLS. Select Verify CA to validate the server certificate. See SSL/TLS for the certificate settings.

Limitations

  • In the tested Oracle configuration, empty strings and empty bytea values become SQL NULL. They do not remain distinct values; use a separate flag column if that distinction matters.
  • Oracle-mode DATE values include a time component. Read and write the time as part of the value.
  • The tested V9R1C10 server rejects NUMERIC 'Infinity'. Use a finite numeric value or a separate status column.
  • A transaction or temporary table in one database is not shared with another database's tab. Keep related statements on the same database connection.

Related