ch_connect 0.2.2 → 0.3.0

data/vendor/clickhouse-c/LICENSE

@@ -0,0 +1,203 @@
+Copyright 2026 ClickHouse, Inc.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 ClickHouse, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/vendor/clickhouse-c/VENDOR.md

@@ -0,0 +1,24 @@
+# Vendored: clickhouse-c
+
+- Source: https://github.com/ClickHouse/clickhouse-c
+- Commit: dd47d2882646aeba5a1946c62a229d57abea6c28 (cloned 2026-07-14)
+- License: Apache-2.0 (see LICENSE)
+
+Only the headers the extension includes are vendored: `clickhouse.h`,
+`clickhouse-compression.h`, `clickhouse-client.h`, `clickhouse-async.h`
+(plus LICENSE). Upstream's tests, docs, tools, and the `clickhouse-posix-io.h`
+/ `clickhouse-openssl.h` I/O backends are not shipped — the extension is
+ioless (Ruby owns the socket and TLS).
+
+## Local patches
+
+- `clickhouse.h` — `chc__col_read`, `case CHC_TUPLE`: ClickHouse serializes the
+  empty `Tuple()` as one UInt8 (zero) per row (ClickHouse/ClickHouse#55061);
+  upstream reads nothing and desyncs the stream. Marked with
+  `LOCAL PATCH (ch_connect)`. Should be upstreamed.
+
+## Updating
+
+Clone the pinned or newer commit, copy the four headers + LICENSE over this
+directory, re-apply the patches above (or drop them once fixed upstream), and
+run the full spec suite with `CH_TRANSPORT=native`.

data/vendor/clickhouse-c/clickhouse-async.h

@@ -0,0 +1,301 @@
+/*
+ * clickhouse-async.h
+ *
+ * Never touches a socket; caller manages bytes:
+ *   - inbound socket bytes  -> chc_async_submit
+ *   - outbound bytes        -> chc_async_pending_out / chc_async_consume_out
+ *
+ * handshake / recv_packet return CHC_WOULD_BLOCK when the input buffer
+ * drains mid-parse; the caller submit more and retries. Sends only ever
+ * append to *out buffer.
+ *
+ * No write backpressure: sends never block, never return CHC_WOULD_BLOCK, and
+ * grow *out unbounded (only OOM fails). Outbound flow control is the caller's.
+ * Use chc_async_pending_out: stop sending when enough pending, resume when
+ * chc_async_consume_out has drained it enough.
+ *
+ * recv keeps parser state alive across CHC_WOULD_BLOCK (in cli.recv_*): a Data
+ * block streamed over many reads resumes at the in-progress column rather than
+ * re-parsing from scratch (uncompressed path, via chc__block_resume_in).
+ * Compressed Data resumes at frame granularity: at most one frame is
+ * re-decompressed and one column re-parsed on retry.
+ */
+
+#ifndef CLICKHOUSE_ASYNC_H
+#define CLICKHOUSE_ASYNC_H
+
+#ifdef CHC_NO_ASYNC
+#  error "clickhouse-async.h needs the ioless reader; remove CHC_NO_ASYNC"
+#endif
+
+#include "clickhouse-client.h"      /* pulls clickhouse.h + clickhouse-compression.h */
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+typedef struct chc_async_client chc_async_client;
+
+/* No I/O, cannot block; only OOM fails. opts->codec carries compression. */
+int  chc_async_client_init(chc_async_client **out, const chc_client_opts *opts,
+                           const chc_alloc *al, chc_err *err);
+void chc_async_client_free(chc_async_client *c);
+
+/* byte shuttle */
+int  chc_async_submit(chc_async_client *c, const void *buf, size_t len,
+                    chc_err *err);
+void chc_async_pending_out(chc_async_client *c, const uint8_t **buf, size_t *len);
+void chc_async_consume_out(chc_async_client *c, size_t n);
+
+/* drive -- never block; CHC_WOULD_BLOCK = submit more / drain out */
+int  chc_async_handshake(chc_async_client *c, chc_err *err);
+int  chc_async_send_query(chc_async_client *c, const char *sql, size_t sql_len,
+                          const char *query_id, size_t query_id_len, chc_err *err);
+int  chc_async_send_data(chc_async_client *c, const chc_block_builder *bb,
+                         chc_err *err);
+int  chc_async_send_data_end(chc_async_client *c, chc_err *err);
+int  chc_async_recv_packet(chc_async_client *c, chc_packet *out, chc_err *err);
+const chc_server_info *chc_async_server_info(const chc_async_client *c);
+
+/* Mirror chc_packet_clear: free p->block / p->exception via the client's
+ * allocator. */
+void chc_async_packet_clear(chc_async_client *c, chc_packet *p);
+
+#ifdef __cplusplus
+}
+#endif
+
+#ifdef CHC_IMPLEMENTATION
+
+/* This block compiles in the same TU as clickhouse-client.h's implementation,
+ * so struct chc_client and the static chc__client_* / chc__recv_packet_resumable /
+ * chc__recv_pong / chc__client_recv_state_free / chc__read_* / chc__mem_sink_*
+ * internals are visible. */
+
+enum {
+    CHC__HS_SEND_HELLO = 0,  /* buffer Hello, advance */
+    CHC__HS_RECV_HELLO,      /* parse server Hello (resumable) */
+    CHC__HS_POST_HELLO,      /* buffer addendum quota_key + Ping */
+    CHC__HS_RECV_PONG,       /* parse Pong (resumable) */
+    CHC__HS_DONE
+};
+
+struct chc_async_client {
+    chc_client    cli;       /* driven directly; not via chc_client_init */
+
+    chc__mem_sink out;       /* outbound write sink; cli.io points at out_io */
+    chc_io        out_io;
+    size_t        out_consumed;  /* bytes of out.buf the caller has drained */
+
+    int           hs_phase;  /* CHC__HS_* */
+
+    /* recv resumption state lives on cli (chc_client.recv_*), shared with the
+     * blocking decoder; persisted across CHC_WOULD_BLOCK. */
+
+    /* Owned copies of the Hello string fields (opts may not outlive init). */
+    char *client_name;
+    char *database;
+    char *user;
+    char *password;
+};
+
+static char *
+chc__async_dup(const chc_alloc *al, const char *s, chc_err *err)
+{
+    return s ? chc__strdup(al, s, strlen(s), err) : NULL;
+}
+
+static void
+chc__async_free_str(const chc_alloc *al, char *s)
+{
+    if (s) al->free(al->ud, s, strlen(s) + 1);
+}
+
+int
+chc_async_client_init(chc_async_client **out, const chc_client_opts *opts,
+                      const chc_alloc *al, chc_err *err)
+{
+    chc_client_opts def_opts = {};
+    if (!opts) opts = &def_opts;
+
+    chc_async_client *c = chc__calloc(al, sizeof *c, err);
+    if (!c) return CHC_ERR_OOM;
+
+    c->cli.al = al;
+    c->cli.client_version_major = opts->client_version_major;
+    c->cli.client_version_minor = opts->client_version_minor;
+    c->cli.client_version_patch = opts->client_version_patch;
+    c->cli.client_revision = opts->client_revision ? opts->client_revision
+                                                   : CHC_CLIENT_DEFAULT_REVISION;
+    c->cli.compression = opts->codec ? opts->compression : CHC_COMP_NONE;
+    c->cli.codec       = opts->codec;
+    /* Seed server.revision so block/packet framing is well-defined before the
+     * handshake completes; recv after handshake uses min(client, server). */
+    c->cli.server.revision = c->cli.client_revision;
+
+    chc__mem_sink_init(&c->out, &c->out_io, al);
+    c->cli.io = &c->out_io;
+
+    int rc = chc_in_init_ioless(&c->cli.in, al);
+    if (rc != CHC_OK) { al->free(al->ud, c, sizeof *c); return rc; }
+
+    /* Own strings used after init. */
+    if ((opts->client_name && !(c->client_name = chc__async_dup(al, opts->client_name, err))) ||
+        (opts->database    && !(c->database    = chc__async_dup(al, opts->database,    err))) ||
+        (opts->user        && !(c->user        = chc__async_dup(al, opts->user,        err))) ||
+        (opts->password    && !(c->password    = chc__async_dup(al, opts->password,    err)))) {
+        chc_async_client_free(c);
+        return CHC_ERR_OOM;
+    }
+
+    c->hs_phase = CHC__HS_SEND_HELLO;
+    *out = c;
+    return CHC_OK;
+}
+
+void
+chc_async_client_free(chc_async_client *c)
+{
+    if (!c) return;
+    const chc_alloc *al = c->cli.al;
+    chc__client_recv_state_free(&c->cli);
+    chc_in_free(&c->cli.in);
+    chc__mem_sink_free(&c->out);
+    chc__async_free_str(al, c->client_name);
+    chc__async_free_str(al, c->database);
+    chc__async_free_str(al, c->user);
+    chc__async_free_str(al, c->password);
+    al->free(al->ud, c, sizeof *c);
+}
+
+int
+chc_async_submit(chc_async_client *c, const void *buf, size_t len, chc_err *err)
+{
+    return chc_in_submit(&c->cli.in, buf, len, err);
+}
+
+void
+chc_async_pending_out(chc_async_client *c, const uint8_t **buf, size_t *len)
+{
+    *buf = c->out.buf + c->out_consumed;
+    *len = c->out.len - c->out_consumed;
+}
+
+void
+chc_async_consume_out(chc_async_client *c, size_t n)
+{
+    size_t avail = c->out.len - c->out_consumed;
+    if (n > avail) n = avail;
+    c->out_consumed += n;
+    /* Fully drained: reset length so the sink doesn't grow unbounded. Keep the
+     * allocation (no realloc-shrink). */
+    if (c->out_consumed == c->out.len) {
+        c->out.len = 0;
+        c->out_consumed = 0;
+    }
+}
+
+int
+chc_async_handshake(chc_async_client *c, chc_err *err)
+{
+    int rc;
+    chc_client *cli = &c->cli;
+
+    for (;;) {
+        switch (c->hs_phase) {
+        case CHC__HS_SEND_HELLO: {
+            chc_client_opts o = {
+                .client_name = c->client_name,
+                .client_version_major = cli->client_version_major,
+                .client_version_minor = cli->client_version_minor,
+                .client_version_patch = cli->client_version_patch,
+                .client_revision = cli->client_revision,
+                .database = c->database,
+                .user = c->user,
+                .password = c->password,
+            };
+            rc = chc__client_send_hello(cli, &o, err);
+            if (rc != CHC_OK) return rc;
+            c->hs_phase = CHC__HS_RECV_HELLO;
+            continue;
+        }
+
+        case CHC__HS_RECV_HELLO:
+            chc__in_checkpoint(&cli->in);
+            rc = chc__client_recv_hello(cli, err);
+            if (rc == CHC_WOULD_BLOCK) { chc__in_rewind(&cli->in); return rc; }
+            if (rc != CHC_OK) return rc;  /* server exception / protocol */
+            chc_in_reset(&cli->in);
+            if (cli->server.revision > cli->client_revision)
+                cli->server.revision = cli->client_revision;
+            c->hs_phase = CHC__HS_POST_HELLO;
+            continue;
+
+        case CHC__HS_POST_HELLO:
+            if (cli->server.revision >= CHC__REV_ADDENDUM) {
+                rc = chc__write_string(cli->io, "", 0, err);  /* quota_key */
+                if (rc != CHC_OK) return rc;
+            }
+            rc = chc_client_send_ping(cli, err);
+            if (rc != CHC_OK) return rc;
+            c->hs_phase = CHC__HS_RECV_PONG;
+            continue;
+
+        case CHC__HS_RECV_PONG:
+            rc = chc__recv_pong(cli, err);  /* owns checkpoint/rewind */
+            if (rc != CHC_OK) return rc;
+            chc_in_reset(&cli->in);
+            c->hs_phase = CHC__HS_DONE;
+            continue;
+
+        case CHC__HS_DONE:
+        default:
+            return CHC_OK;
+        }
+    }
+}
+
+int
+chc_async_send_query(chc_async_client *c, const char *sql, size_t sql_len,
+                     const char *query_id, size_t query_id_len, chc_err *err)
+{
+    return chc_client_send_query(&c->cli, sql, sql_len, query_id, query_id_len, err);
+}
+
+int
+chc_async_send_data(chc_async_client *c, const chc_block_builder *bb, chc_err *err)
+{
+    return chc_client_send_data(&c->cli, bb, err);
+}
+
+int
+chc_async_send_data_end(chc_async_client *c, chc_err *err)
+{
+    return chc_client_send_data(&c->cli, NULL, err);
+}
+
+const chc_server_info *
+chc_async_server_info(const chc_async_client *c)
+{
+    return &c->cli.server;
+}
+
+void
+chc_async_packet_clear(chc_async_client *c, chc_packet *p)
+{
+    chc_packet_clear(&c->cli, p);
+}
+
+/* The recv packet decoder is shared with the blocking client
+ * (chc__recv_packet_resumable, clickhouse-client.h): the ioless `cli.in`
+ * makes it checkpoint at packet/column boundaries and yield CHC_WOULD_BLOCK
+ * on underrun, with c->cli.recv_* carrying parse state across calls. */
+int
+chc_async_recv_packet(chc_async_client *c, chc_packet *out, chc_err *err)
+{
+    return chc__recv_packet_resumable(&c->cli, out, err);
+}
+
+#endif /* CHC_IMPLEMENTATION */
+
+#endif /* CLICKHOUSE_ASYNC_H */