Skip to content

Commit db1e1c5

Browse files
committed
Chore: This and that
1 parent b89ad89 commit db1e1c5

File tree

2 files changed

+28
-8
lines changed

2 files changed

+28
-8
lines changed

doc/backlog/main.md

+13-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,19 @@
11
# Main Backlog
22

33
## Iteration +0
4-
- CLI: Consider simplifying by using `--url` instead of `--sqlalchemy-url` or `--http-url`
4+
- CLI: Consider simplifying the API by using canonical `--cluster-url` instead of `--sqlalchemy-url` vs. `--http-url`
55
- CLI: Explore consolidating all four addressing options into a single `--cluster` option
6-
for more intuitive cluster addressing. This could be implemented as an option alongside existing methods.
6+
for more intuitive cluster addressing. This could be implemented as a separate option alongside
7+
existing methods.
8+
- `cratedb_toolkit/cfr/cli.py`: Migrate to `ctx.meta["address"]`, like `cratedb_toolkit/info/cli.py`
9+
- Cluster API: Currently, software tests do not prune tables on CrateDB Cloud.
10+
This will probably cause a disk spillover sooner or later on this instance.
11+
- When running the test suite, a huge log obstructs the output information.
12+
```
13+
2025-05-03 22:48:22,191 [crate.client.http ] DEBUG : JSON response for stmt(SELECT * FROM "sys"."allocations")
14+
2025-05-03 22:48:22,768 [crate.client.http ] DEBUG : JSON response for stmt(SELECT * FROM "sys"."jobs_log")
15+
```
16+
- Refactor `model.py`, `util/database.py`, and possibly more, to `ctk.model` module namespace
717

818
## Iteration +1
919
- Table Loader: Refactor URL dispatcher, use fsspec
@@ -49,7 +59,7 @@
4959
- UX: Accept alias `--format {jsonl,ndjson}` for `--format json_row`
5060
- Catch recursion errors:
5161
```
52-
CRATEDB_SQLALCHEMY_URL=crate://crate@localhost:4200/
62+
CRATEDB_CLUSTER_URL=crate://crate@localhost:4200/
5363
```
5464
- CLI: Verify exit codes.
5565
- UX: Rename `ctk cluster info` to `ctk status cluster --id=foo-bar-baz`

doc/cluster/backlog.md

+15-5
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,21 @@ a patch for some item, it will be very much welcome.
1212
[issues]: https://github.com/crate/cratedb-toolkit/issues
1313

1414
## Iteration +1
15-
- `ctk cluster info` does not include information about CrateDB yet.
16-
=> Connect to ex-WTF utilities.
17-
- Less verbosity by default for `ctk cluster` operations.
15+
- CLI: Less verbosity by default for `ctk cluster` operations
1816
Possibly display cluster operation and job execution outcomes, and `last_async_operation` details
19-
- Python API: Make `cluster.query` use the excellent `records` package
20-
- `ctk cluster list`: New
17+
- CLI: Implement `ctk cluster list`, `ctk cluster delete`
18+
- Shell: Make prompt display the cluster name
19+
- Managed: Use `keyring` for caching the JWT token, and compensate token expiry
2120

2221
## Iteration +2
22+
- Python API: Make `cluster.query` use the excellent `records` package
2323
- Xon.sh example
2424
- Windows support. Powershell?
2525
- Validate multi-cluster, multi-org operations work well and make sense
2626
- Implement JWT token expiry handling
2727
- Add Apache Spark / Databricks to the client bundle?
28+
- Use universal `DatabaseCluster` across the board. For that to happen, it will
29+
need to gain an `DatabaseCluster.from_env()` entry point.
2830

2931
## Iteration +3
3032
- Complete UI: `ctk cluster health`
@@ -87,3 +89,11 @@ a patch for some item, it will be very much welcome.
8789
using different credentials for connecting to individual clusters.
8890
- Document `ManagedCluster`'s `stop_on_exit` option
8991
- `toolkit/cluster/cli.py`: Also respect cluster ID and name across the board of ex-WTF utilities.
92+
- `ctk cluster info` does not include information about CrateDB yet.
93+
=> Connect to ex-WTF utilities.
94+
- Make CLI options override ENV vars. Otherwise, using `--sqlalchemy-url=crate://`
95+
will never work if an `.env` file is present.
96+
- SDK: Rename `ctk.cluster` to `ctk.sdk`? => No.
97+
- CLI: Shrink address URLs to single parameter `--cluster-url`
98+
- Changelog: Notify about breaking change with input address parameter names
99+
- Docs: Update guidelines about input address parameter preferences

0 commit comments

Comments
 (0)