arcadedb-driver 0.1.0__tar.gz

arcadedb_driver-0.1.0/.gitignore

@@ -0,0 +1,10 @@
+node_modules/
+dist/
+*.tsbuildinfo
+.DS_Store
+coverage/
+.ruff_cache/
+__pycache__/
+.venv/
+.mypy_cache/
+.pytest_cache/

arcadedb_driver-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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 [yyyy] [name of copyright owner]
+
+   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.

arcadedb_driver-0.1.0/PKG-INFO

@@ -0,0 +1,292 @@
+Metadata-Version: 2.5
+Name: arcadedb-driver
+Version: 0.1.0
+Summary: Python HTTP client for ArcadeDB, generated from ArcadeDB's OpenAPI contract.
+Project-URL: Homepage, https://github.com/ArcadeData/arcadedb-drivers/tree/main/python/packages/driver#readme
+Project-URL: Issues, https://github.com/ArcadeData/arcadedb-drivers/issues
+Project-URL: Repository, https://github.com/ArcadeData/arcadedb-drivers
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: arcadedb,database,graph-database,http-client,multi-model
+Requires-Python: >=3.10
+Requires-Dist: attrs>=23.2
+Requires-Dist: httpx>=0.27
+Requires-Dist: typing-extensions>=4.10
+Description-Content-Type: text/markdown
+
+# arcadedb-driver
+
+A Python HTTP client for [ArcadeDB](https://arcadedb.com), generated from ArcadeDB's OpenAPI
+contract, with a hand-written facade on top for the data plane, transactions, and the pieces of
+the contract the generator cannot model.
+
+**This package is not yet published to PyPI.** The instructions below describe how it will be
+installed and used once a release is made; until then, consume it from this repository (workspace
+install, or `uv build` a wheel yourself).
+
+## Requirements
+
+- Python `>=3.10`.
+- An ArcadeDB server at or near the version in the compatibility table below.
+
+## Installation
+
+```bash
+pip install arcadedb-driver
+```
+
+or, in a [uv](https://docs.astral.sh/uv/) project:
+
+```bash
+uv add arcadedb-driver
+```
+
+## Quick start
+
+```python
+from arcadedb_driver import ArcadeDBServer, basic_auth
+
+with ArcadeDBServer(base_url="http://localhost:2480", auth=basic_auth("root", "playwithdata")) as srv:
+    db = srv.db("mydb")
+    envelope = db.query(language="sql", command="SELECT FROM Person WHERE age > ?", params={"1": 21})
+    print(envelope.result)
+```
+
+A bearer token (for example, a session token returned by `/api/v1/login`) works the same way:
+
+```python
+from arcadedb_driver import ArcadeDBServer, bearer_auth
+
+with ArcadeDBServer(base_url="http://localhost:2480", auth=bearer_auth("AU-...")) as srv:
+    ...
+```
+
+The async facade mirrors the sync one method-for-method:
+
+```python
+import asyncio
+
+from arcadedb_driver import AsyncArcadeDBServer, basic_auth
+
+
+async def main() -> None:
+    async with AsyncArcadeDBServer(base_url="http://localhost:2480", auth=basic_auth("root", "playwithdata")) as srv:
+        db = srv.db("mydb")
+        envelope = await db.query(language="sql", command="SELECT FROM Person WHERE age > ?", params={"1": 21})
+        print(envelope.result)
+
+
+asyncio.run(main())
+```
+
+## The result envelope, and why `truncated` matters
+
+`query` and `command` do not return bare rows. They return the whole response envelope:
+
+```python
+@dataclass(frozen=True, slots=True)
+class QueryEnvelope:
+    result: list[dict[str, Any]]
+    limit: int
+    returned: int
+    truncated: bool
+```
+
+`truncated` is `True` when the server's serializer hit its row cap while a query still had more
+rows to write - `result` is then a partial answer, not a short-but-complete one. A caller that
+reads `result` and ignores `truncated` can silently work off a partial answer, because a truncated
+list and a complete one are indistinguishable by shape alone. Always check `truncated` before
+treating `result` as the whole answer, and re-query with a narrower filter or a higher `limit`
+when it is `True` - though raising `limit` is not always the fix: a result whose true size exceeds
+the server's hard ceiling (`arcadedb.server.httpQueryMaxResultRows`) is refused outright with 413
+rather than truncated, so once you are past that ceiling a narrower filter is the only way forward.
+
+`limit` and `truncated` in the envelope above both default when the server's response omits them
+(`limit` to `-1`, meaning uncapped; `returned` to `0`; `truncated` to `False`) - `QueryResponse`
+has no required fields in the contract, so all four are, strictly, optional on the wire. In
+practice the server always sends all four today, but a caller relying on `truncated is False` as
+proof of completeness is trusting a client-side default, not a server guarantee.
+
+## Sync and async
+
+`ArcadeDBServer` and `AsyncArcadeDBServer` expose the same methods; the async one awaits them.
+Both are context managers - `with` for the sync client, `async with` for the async one - because
+each owns an `httpx` client with its own connection pool that must be released. Use the context
+manager form where you can; call `close()` (sync) or `await aclose()` (async) yourself otherwise.
+
+```python
+srv = ArcadeDBServer(base_url="http://localhost:2480")
+try:
+    ...
+finally:
+    srv.close()
+```
+
+Both constructors take a `timeout: httpx.Timeout | None = None`, and omitting it disables
+timeouts entirely - it is not "use httpx's default" (5 seconds), it is no timeout at all, because
+in httpx an explicit `timeout=None` means exactly that. This is deliberate: the generated `Client`
+these facades wrap defaults its own timeout to `None` and forwards it the same way, and
+`@arcadedb/driver` has no default timeout either, since `fetch` doesn't have one. Pass an
+`httpx.Timeout` if you want requests bounded:
+
+```python
+srv = ArcadeDBServer(base_url="http://localhost:2480", timeout=httpx.Timeout(5.0))
+```
+
+## Transactions
+
+```python
+with srv.db("mydb").transaction() as tx:
+    tx.command(language="sql", command="INSERT INTO Account SET balance = 100")
+    total = tx.query(language="sql", command="SELECT sum(balance) as total FROM Account").result[0]["total"]
+```
+
+or, async:
+
+```python
+async with srv.db("mydb").transaction() as tx:
+    await tx.command(language="sql", command="INSERT INTO Account SET balance = 100")
+```
+
+`transaction()` returns a context manager whose `__enter__` (`__aenter__`) begins a server-side
+transaction and hands back a SECOND database handle carrying its session id. Every call made
+through that `tx` handle - not through the outer `db` object used to open the transaction - takes
+part in it; a call made through the outer handle while a transaction is open auto-commits on its
+own, outside the transaction, exactly as if no transaction were open at all.
+
+The commit/rollback contract has three clauses:
+
+- The block exits cleanly: the transaction commits.
+- The block raises: the transaction rolls back and the block's exception propagates. If that
+  rollback itself also fails, the rollback's error is attached as `__cause__` on the block's
+  exception rather than replacing it - the block's own error is what the caller asked about - and
+  the attach is silently skipped if `__cause__` is already set or if attaching it fails outright.
+- The commit itself fails: a best-effort rollback is issued first (its own failure discarded) so
+  the server-side session is not left open until `arcadedb.server.httpTxExpireTimeout` reaps it,
+  and then the commit's error is re-raised.
+
+## Two error models
+
+The facade methods (`query`, `command`, `transaction`, `list_databases`, `exists`, `server_info`,
+`health`, `ready`, the `ts`/`grafana`/`promql` namespaces, ...) raise `ArcadeDBError` on any
+non-2xx response:
+
+```python
+from arcadedb_driver import ArcadeDBError
+
+try:
+    db.query(language="sql", command="SELECT FROM NoSuchType")
+except ArcadeDBError as err:
+    print(err.status, err.error, err.detail, err.request_id, err.help_)
+```
+
+`err.help_` is spelled with a trailing underscore to match the field name on the generated
+`ErrorResponse` model, which is reachable through `.raw` - `help` alone would shadow the Python
+builtin, and picking a different spelling for the same field on the two error surfaces this
+package exposes would be worse than one awkward name used consistently.
+
+`server.raw`, the underlying generated client, does **not** raise. Every one of its operations
+returns a `Response` whose `status_code` and `parsed` the caller inspects directly:
+
+```python
+from arcadedb_driver._generated.api.database import list_databases
+
+response = list_databases.sync_detailed(client=srv.raw)
+if response.status_code >= 300:
+    ...  # handle it yourself; srv.raw never raises
+```
+
+These are two deliberately different contracts in one package. Use the facade for the ergonomics
+of `try`/`except`; use `.raw` when you want to branch on a status code without exceptions. Mixing
+assumptions about which one you're calling is the most common way to end up with an unhandled
+exception or a silently ignored error.
+
+## `exists` cannot prove absence
+
+```python
+present = srv.exists("mydb")
+```
+
+`exists` returns `False` both when the database genuinely does not exist and when it exists but
+the authenticated caller is not authorized to see it - the server's response does not distinguish
+the two cases, so this client cannot either. Do not treat `False` as proof that a database is
+absent; it only means "not visible to this caller right now."
+
+## Endpoints this client does not wrap
+
+Two distinct things are true about parts of the contract, and they should not be confused with
+each other.
+
+**Not wrapped at all.** `POST /api/v1/batch/{database}` (a jsonl/ndjson/csv body),
+`POST /api/v1/ts/{database}/prom/read` and `POST /api/v1/ts/{database}/prom/write` (protobuf
+bodies) are endpoints the generator cannot model - it has no way to describe a non-JSON request
+body, so it prints a warning, skips the endpoint entirely, and exits 0. Nothing downstream notices
+on its own: a skipped endpoint leaves no trace in the generated tree for `git diff` to flag. This
+package pins the exact skip set in `scripts/check_codegen_skips.py`, which re-runs the generator
+against the committed contract and fails if the set of skipped operations changes - so a future
+contract that starts describing `batch` in a way the generator *can* model, or drops one of these
+endpoints, cannot pass unnoticed.
+
+`db.ts.write` (`POST /api/v1/ts/{database}/write`, InfluxDB line protocol as `text/plain`) has the
+same generator limitation but is hand-written rather than left unwrapped, because a time-series
+namespace that could query samples but never ingest any would be an odd thing to ship.
+
+`POST /api/v1/server` (administrative commands) is likewise not wrapped by the facade, and reached
+through `.raw` returns a body that does not conform to its declared `QueryResponse` schema
+(`{"result": "ok"}` where an array is declared), so the generated model raises on an otherwise
+successful call.
+
+**Wrapped, but returning `dict[str, Any]` instead of a generated model.** Unlike `batch`,
+`prom/read`, and `prom/write` above, these three routes describe a JSON body the generator *can*
+model, and it does generate operation functions and response models for them -
+`_generated/api/time_series/query_time_series.py`, `get_time_series_latest.py`, and
+`_generated/api/grafana/query_grafana.py` all exist on disk. But `db.ts.query`, `db.ts.latest`,
+and `db.grafana.query` do not call any of those generated operations - they are hand-written, and
+none of the three generated modules above is imported anywhere outside its own package. Each
+method builds the request URL itself and issues it directly through the same pooled httpx client
+the generated operations use (`self._client.get_httpx_client()`, or its async twin), returning the
+parsed JSON body rather than routing the response through a generated model at all.
+
+The reason is the same in all three: the contract types each of these responses' per-element
+scalar values (a timestamp, a numeric measurement, a DataFrame cell) as `"type": "object"`, so the
+generated per-element model's `from_dict` calls `dict(value)` on every element - which raises
+`TypeError` on an ordinary scalar like a float or an int. Had these methods routed through the
+generated operations instead, `db.ts.query`'s `oneOf` response parser would have caught that
+`TypeError` and silently fallen through to the aggregated-response model, whose fields are all
+optional and so "parses" anything - every raw (non-aggregated) query response would come back
+mis-typed as an empty-looking aggregated one instead of raising. `db.ts.latest` and
+`db.grafana.query` have no such fallback branch and would simply raise `TypeError` on any real
+response. `@arcadedb/driver`, the TypeScript sibling, is unaffected only because `openapi-fetch`
+performs no runtime validation of its own - the raw JSON passes through unexamined. Bypassing the
+generated operations and returning the parsed body directly is the Python equivalent, and the only
+correct behaviour, until the contract is fixed upstream to type these fields correctly; fixing the
+contract is also what would let these three methods move onto the generated operations and return
+generated models, the same way `db.promql.*` already does - `db.promql.*` is unaffected by any of
+this today because its response schemas do not have this shape.
+
+## Contract version and compatibility
+
+This package was generated from `contracts/arcadedb-openapi-26.9.1.json`, recorded in
+`pyproject.toml` as `tool.arcadedb.server-version`:
+
+```toml
+[tool.arcadedb]
+server-version = "26.9.1"
+```
+
+| `arcadedb-driver` | ArcadeDB server |
+| --- | --- |
+| 0.1.0 | 26.9.1 |
+
+This table is a historical record tied to a package version, not something derived automatically:
+`scripts/adopt-contract-version.sh` deliberately does not touch it when it retires an old contract
+and adopts a new one. Adding a row is a human decision made at release time, not a side effect of
+a contract bump.
+
+The client speaks ArcadeDB's HTTP API as described by that contract. Pointing it at a server on a
+materially different release may work for the endpoints both versions share, but is not tested or
+supported.
+
+## License
+
+Apache-2.0.