From 9597392b60da2327a9d18c2a62e743f81d5c7285 Mon Sep 17 00:00:00 2001 From: Taewoon Kim Date: Fri, 6 Nov 2026 02:15:54 +0900 Subject: [PATCH] Docs: reword the install notes for the 26.11.1 finals Closes #275 Co-Authored-By: Claude Sonnet 5.5 --- README.md | 4 ++-- docs/modules/ROOT/pages/how-to/bulk-loads.adoc | 2 +- docs/modules/ROOT/pages/index.adoc | 2 +- docs/modules/ROOT/pages/installation.adoc | 6 +++--- docs/modules/ROOT/pages/quickstart.adoc | 2 +- docs/modules/ROOT/pages/which-package.adoc | 4 ++-- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index baaaccf1..692fc5bc 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ uv add arcadedb-jvm # JVM, for heavy long-running loads ``` -> Transition note: the first release of this layout is 26.11.1. Until `arcadedb` passes its readiness bar, it may appear only as pre-releases, `26.11.1.devN`. Until a final 26.11.1 exists, PyPI holds only these pre-releases, and a plain `uv add arcadedb` installs the newest one. After a final release, a plain install takes the final, and a later pre-release needs `uv add --prerelease allow arcadedb`. The same holds for `arcadedb-jvm`. +> The first release of this layout is 26.11.1, and both packages have a final release on PyPI. A plain `uv add arcadedb` installs the final, and a later pre-release (`A.B.C.devN`) needs `uv add --prerelease allow arcadedb`. The same holds for `arcadedb-jvm`. > Old names: `arcadedb-jvm` was formerly `arcadedb-embedded`, and `arcadedb` was formerly `arcadedb-embedded-native` (archived on PyPI). A last `arcadedb-embedded` release will be a deprecation shim that installs `arcadedb`, the native build. @@ -72,7 +72,7 @@ For several processes, other languages, HA or replication, run the official Dock | Package | What it is | Status | |---|---|---| -| [`arcadedb`](https://pypi.org/project/arcadedb/) | The native build: the engine compiled by GraalVM Community Edition, no JVM, no JPype. The default for embedded use | First release of this layout: 26.11.1. It may first appear as `26.11.1.devN` pre-releases | +| [`arcadedb`](https://pypi.org/project/arcadedb/) | The native build: the engine compiled by GraalVM Community Edition, no JVM, no JPype. The default for embedded use | First release of this layout: 26.11.1 | | [`arcadedb-jvm`](https://pypi.org/project/arcadedb-jvm/) | The JVM build: the Java engine on a bundled JVM, through JPype. The package this README described before the two-package layout | First release from this repository: 26.11.1 | diff --git a/docs/modules/ROOT/pages/how-to/bulk-loads.adoc b/docs/modules/ROOT/pages/how-to/bulk-loads.adoc index 3ba0d541..1b28f105 100644 --- a/docs/modules/ROOT/pages/how-to/bulk-loads.adoc +++ b/docs/modules/ROOT/pages/how-to/bulk-loads.adoc @@ -164,7 +164,7 @@ An engine-level Java run of the same shape confirms the split: after 2,000 round The engine-level Java run, repeated on the merge of the fix, kept the batch's edge bucket at 4 pages after 2,000 rounds, the same as `newEdge` in ordinary transactions, against 2,000 pages on its parent (https://github.com/ArcadeData/arcadedb/issues/10746#issuecomment-6462354150[verification on #10746]). -On a `26.11.1.devN` pre-release, if your workload deletes and inserts again, write the edges with SQL (`CREATE EDGE`) or with `Vertex.new_edge` inside `db.transaction()`. Both stayed flat in the measurement (0.25 MiB in the table). From 26.11.1 on, `graph_batch()` is fine for this workload too. +From 26.11.1 on, `graph_batch()` is fine for a workload that deletes and inserts again. On a `26.11.1.devN` pre-release, write the edges with SQL (`CREATE EDGE`) or with `Vertex.new_edge` inside `db.transaction()` instead. Both stayed flat in the measurement (0.25 MiB in the table). == If a graph batch is interrupted diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc index a9c45743..b6d11ef1 100644 --- a/docs/modules/ROOT/pages/index.adoc +++ b/docs/modules/ROOT/pages/index.adoc @@ -24,7 +24,7 @@ These packages run the ArcadeDB engine inside your Python process, with no netwo Not sure which one? Take `{native-pkg-name}`, and read xref:which-package.adoc[Which package?] to decide for sure. Install one of them, not both. // REMOVE WHEN: the old arcadedb-embedded* shims are retired and two releases have shipped with the two-package layout allow-old-name -NOTE: *Transition note.* The first release of this layout is 26.11.1, and `{native-pkg-name}` may first appear as pre-releases, `26.11.1.devN`. Until a final 26.11.1 is on PyPI, these pre-releases are all there is, and a plain `uv add {native-pkg-name}` installs the newest one. See xref:installation.adoc[Installation]. +NOTE: *First release.* The first release of this layout is 26.11.1, and both packages have a final release on PyPI. A plain `uv add {native-pkg-name}` installs the final. See xref:installation.adoc[Installation]. ArcadeDB is a multi-model database: graph, document, key/value, vector and time series data live in one database, and you query it with SQL or openCypher. The bindings expose the two calls you need for that, `db.command(...)` and `db.query(...)`. diff --git a/docs/modules/ROOT/pages/installation.adoc b/docs/modules/ROOT/pages/installation.adoc index 45e29999..828733e6 100644 --- a/docs/modules/ROOT/pages/installation.adoc +++ b/docs/modules/ROOT/pages/installation.adoc @@ -24,7 +24,7 @@ Pick one of the two packages. Both import as `{import-name}`. If you are not sur Install one of them, not both. If both are installed, `import arcadedb` raises an `ImportError` that names both packages. See xref:which-package.adoc[Which package?] for the comparison, and for how to switch. // REMOVE WHEN: the old arcadedb-embedded* shims are retired and two releases have shipped with the two-package layout allow-old-name -NOTE: *Transition note.* The first release of this layout is 26.11.1. Until `{native-pkg-name}` passes its readiness bar, it may appear only as pre-releases, `26.11.1.devN`. Until a final 26.11.1 exists, PyPI holds only these pre-releases, and a plain `uv add {native-pkg-name}` installs the newest one. After a final release, a plain install takes the final, and a later pre-release needs `uv add --prerelease allow {native-pkg-name}` or `uv add --prerelease allow {native-pkg-name}`. The same holds for `{jvm-pkg-name}`. +NOTE: *First release.* The first release of this layout is 26.11.1, and both packages have a final release on PyPI. A plain `uv add {native-pkg-name}` installs the final, and a later pre-release (`A.B.C.devN`) needs `uv add --prerelease allow {native-pkg-name}`. The same holds for `{jvm-pkg-name}`. // REMOVE WHEN: the old arcadedb-embedded* shims are retired and two releases have shipped with the two-package layout allow-old-name NOTE: *Old names.* The JVM package was formerly `arcadedb-embedded`. It is now `{jvm-pkg-name}`, the same build. The native package was formerly `arcadedb-embedded-native`. It is now `{native-pkg-name}`, and the old project is archived. A last `arcadedb-embedded` release will install `{native-pkg-name}`, not `{jvm-pkg-name}`. See xref:which-package.adoc#old-names[Old names]. @@ -98,11 +98,11 @@ with arcadedb.create_database("./test") as db: print(f"Database working: {result.first().get('test') == 1}") ---- -Run in an empty directory, the script prints (the version and the backend match what you installed; this output is from `{native-pkg-name}` 26.11.1.dev2, and `{jvm-pkg-name}` prints `Backend: jvm`): +Run in an empty directory, the script prints (the version and the backend match what you installed; this output is from `{native-pkg-name}` 26.11.1, and `{jvm-pkg-name}` prints `Backend: jvm`): [source,text] ---- -ArcadeDB Python bindings version: 26.11.1.dev2 +ArcadeDB Python bindings version: 26.11.1 Backend: native Database working: True ---- diff --git a/docs/modules/ROOT/pages/quickstart.adoc b/docs/modules/ROOT/pages/quickstart.adoc index d3ce1e15..50b74046 100644 --- a/docs/modules/ROOT/pages/quickstart.adoc +++ b/docs/modules/ROOT/pages/quickstart.adoc @@ -18,7 +18,7 @@ This page builds a small database from scratch. You need one of the two packages | Heavy, long-running loads, or the Java-object APIs. |=== -See xref:which-package.adoc[Which package?] if you are not sure. If you are not sure, take `{native-pkg-name}`. Until a final 26.11.1 is on PyPI, add `--prerelease allow` to the `uv add` line of `{native-pkg-name}` (see the transition note in xref:installation.adoc[Installation]). +See xref:which-package.adoc[Which package?] if you are not sure. If you are not sure, take `{native-pkg-name}`. // REMOVE WHEN: the old arcadedb-embedded* shims are retired and two releases have shipped with the two-package layout allow-old-name The scripts on this page ran against the JVM build, version 26.10.2.post1 (formerly `arcadedb-embedded`). The output shown is what it printed. The code is the same for both packages. The wording of an error message can differ on `{native-pkg-name}`. diff --git a/docs/modules/ROOT/pages/which-package.adoc b/docs/modules/ROOT/pages/which-package.adoc index 8f6f5cff..930d1f65 100644 --- a/docs/modules/ROOT/pages/which-package.adoc +++ b/docs/modules/ROOT/pages/which-package.adoc @@ -25,7 +25,7 @@ uv add {jvm-pkg-name} # JVM, for heavy long-running loads If you are not sure, install `{native-pkg-name}`. You can switch later: your code does not change (see <>). // REMOVE WHEN: the old arcadedb-embedded* shims are retired and two releases have shipped with the two-package layout allow-old-name -NOTE: *Transition note.* The first release of this layout is 26.11.1. Until the native build passes its readiness bar, `{native-pkg-name}` may appear only as pre-releases, `26.11.1.devN`. Until a final 26.11.1 exists, PyPI holds only these pre-releases, and a plain `uv add {native-pkg-name}` installs the newest one. After a final release, a plain install takes the final, and a later pre-release needs `uv add --prerelease allow {native-pkg-name}` (or `uv add --prerelease allow {native-pkg-name}`). The same holds for `{jvm-pkg-name}`. The readiness bar is listed in xref:development/release.adoc[Release]. +NOTE: *First release.* The first release of this layout is 26.11.1, and both packages have a final release on PyPI. A plain `uv add {native-pkg-name}` installs the final, and a later pre-release (`A.B.C.devN`) needs `uv add --prerelease allow {native-pkg-name}`. The same holds for `{jvm-pkg-name}`. The readiness bar for the native build is listed in xref:development/release.adoc[Release]. [[which-one-do-i-have]] == Check which one you have @@ -143,7 +143,7 @@ The packages had other names until 26.10.x. Search results and old tutorials may === Migrate from the old names . Remove the old package: `uv remove arcadedb-embedded`, or `uv remove arcadedb-embedded-native` if that is the one you have. -. Install the new one: `uv add {jvm-pkg-name}` if you used `arcadedb-embedded`, or `uv add {native-pkg-name}` if you used `arcadedb-embedded-native`. Add `--prerelease allow` while the transition note above applies. +. Install the new one: `uv add {jvm-pkg-name}` if you used `arcadedb-embedded`, or `uv add {native-pkg-name}` if you used `arcadedb-embedded-native`. . Change the import: `import arcadedb_embedded` and `import arcadedb_native` both become `import {import-name}`. The builds are the same as in the table above, so the rest of your code stays. Releases of the new layout start with 26.11.1. The 26.10.x wheels were built in a separate repository of the humemai organisation.