#shiyukonghui/kingbase-client

#Install

{
  "deps": {
    "shiyukonghui/kingbase-client": { "path": "../kingbase-client" }
  }
}

moon add shiyukonghui/kingbase-client

import {
  "shiyukonghui/kingbase-client" @kb,
  "shiyukonghui/kingbase-client/dialect" @dialect,
}

#Requirements

#Use

let cfg = @kb.new_config("db.example.com", 54321, "app", secret, "app")
let client = @kb.connect(cfg)
let rs = client.query("select id, amount from mb_orders where id = 42")
println(rs.cell(0, 1))
client.close()

let stream = client.copy_in("copy mb_orders (id, name, amount) from stdin")
let row = @kb.new_copy_row(@buffer.Buffer(size_hint=1024))
row.write_int64(7L)
row.write_text("product-1")
row.write_decimal(1234567L, 4) // numeric(18,4) -> 123.4567
row.end_row()
stream.send_data(row.take())
println(stream.finish()) // "COPY 1"

let d = client.dialect()
let n = client.query("update mb_orders set status = 'closed' where id <= 1000").affected()
println(n) // 1000 -- "UPDATE 1000"; `SELECT 1` and `COPY 5000` parse the same way
client.execute(d.begin_statement()) // "begin", or "begin transaction" in sqlserver mode
client.execute("commit")

#The four modes

let d = client.dialect()
println(d.mode) // Sqlserver
println(d.setting("sql_mode")) // ONLY_FULL_GROUP_BY,ANSI_QUOTES
println(d.column_type(@dialect.Timestamp)) // datetime
println(d.limit_clause(100, 500)) // offset 500 rows fetch next 100 rows only

1. Behaviour is read from settings, not assumed from the mode name. enable_ci, ora_input_emptystr_isnull, quoted_identifier, sql_mode, copy_mode, DateStyle, DateFormat and standard_conforming_strings each decide a rule the mode name alone would only guess at. Not every mode defines every name, so the client reads the catalog view first, then show for each name still missing, and treats a refusal as "this mode has no such setting" rather than as a failure.
2. Every rule carries its evidence in a comment: measured (observed on a live instance) or documented (manual only). All four modes below have been measured against one instance each on 2026-10-09.

#Measured limits, in all four modes

• The extended query protocol is refused everywhere: a lone Parse message answers 08P01 ("insufficient data left in message"), from this library and from an independent implementation alike. The session survives it. The simple protocol is what the client uses.
• COPY ... FROM STDIN WITH (FORMAT BINARY) works in all four modes: a PGCOPY image loads and reads back correctly. WITH (BINARY) is not a valid option and answers 42601. Dialect::binary_copy_supported reports it.
• Prepared statements are reachable as SQL. A parameterised one (prepare p(int) as select $1 + 1; execute p(41)) runs in every mode. A parameterless one runs in pg, oracle and mysql mode, but sqlserver mode reads execute p as a stored-procedure call (42883) and execute p() as a syntax error (42601).
• getdate() — the SQL Server form — is refused in all four modes; now() answers everywhere and is what Dialect::now_expression returns.
• sqlserver mode refuses bare begin (42601, "syntax error at end of input"), because there the word opens a BEGIN ... END block. begintransaction opens one in all four modes, and begin tran — SQL Server's abbreviation — only in that one. commit and rollback are bare-safe everywhere, so only the opening statement needs a dialect: Dialect::begin_statement.
• In sqlserver mode a column declared timestamp is the rowversion type, not a time: cast('2022-01-01 10:20:30' as timestamp) yields 0x323032322D30312D. Use datetime, which the dialect does.
• Text output differs per mode and per function: pg mode prints a UTC offset for both now() and current_timestamp, sqlserver mode prints one for now() but none for current_timestamp, mysql mode prints none for either. The client therefore returns values as text and parses nothing.

#Validating an instance

kingbase_bench probe     --host=IP --port=PORT --user=NAME --password=SECRET --database=NAME   # 52 read-only checks
kingbase_bench livecheck --host=IP ...                                                        # 14 dialect rules, one verdict each
kingbase_bench crud      --host=IP ...                                                        # 37 single-row and batch DML checks

#Tests

#Release

cmd //c "native.cmd check --target native"        # 0 errors, 0 warnings
cmd //c "native.cmd test  --target native"        # the offline suite
cmd //c "native.cmd info  --target native"        # regenerate pkg.generated.mbti
moon package --list                               # what would be uploaded

moon register          # once, at https://mooncakes.io
moon login             # writes ~/.moon/credentials.json
moon publish           # version must be SemVer and higher than any published one