You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* removal of core
* removal of bulk_write
* removal of vector, vectorize, vectors parameters to collection methods
* removed .collection and .retrieved of cursors
* remove set_caller; bump to 2.0.0
* removed caller_name, caller_version param pair
* removed id/region pattern in DataAPIClient get_database methods
* refactor get_database_by_api_endpoint as alias; adjust admin tests not to use id/region
* removed all namespace aliases in API
* full removal of all 'namespace' things
Copy file name to clipboardExpand all lines: README.md
+10-97Lines changed: 10 additions & 97 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,8 +2,7 @@
2
2
3
3
A pythonic client for [DataStax Astra DB](https://astra.datastax.com).
4
4
5
-
_This README targets AstraPy version **1.0.0+**, which introduces a whole new API.
6
-
Click [here](https://github.com/datastax/astrapy/blob/cd3f5ce8146093e10a095709c0f5c3f8e3f2c7da/README.md) for the pre-existing API (fully compatible with newer versions)._
5
+
_This README targets **AstraPy version 2.0+**. Click [here](https://github.com/datastax/astrapy/blob/4601c5fa749925d961de1f114ca27690d1a71b13/README.md) for v1 and [here](https://github.com/datastax/astrapy/blob/cd3f5ce8146093e10a095709c0f5c3f8e3f2c7da/README.md) for the v0 API (which you should not really be using by now)._
7
6
8
7
9
8
## Quickstart
@@ -253,7 +252,6 @@ Tests are grouped in three _blocks_ (in as many subdirs of `tests/`):
253
252
254
253
-**idiomatic**: all 1.0+ classes and APIs, except...
255
254
-**vectorize**: ... everything making use of `$vectorize` (within the idiomatic classes)
256
-
-_(core: pre-1.0 classes). Frozen as of v1.5, deprecated for removal in v2.0_
257
255
258
256
Actually, for convenience, _sub-blocks_ of tests are considered:
259
257
@@ -262,8 +260,6 @@ Actually, for convenience, _sub-blocks_ of tests are considered:
262
260
-**idiomatic admin nonAstra**: the nonAstra-specific admin operations
263
261
-**vectorize in-depth**: many Data API interactions for a single choice of provider/model. This is mostly test the client
264
262
-**vectorize all-providers**: a slightly more shallow test repeated for all providers, models, auth methods etc. This is mostly testing the API
Tests can be run on three types of Data API _targets_ (with slight differences in what is applicable):
269
265
@@ -275,7 +271,7 @@ Depending on the (sub-block, target) combination, some environment variables may
275
271
Templates for the environment variables are to be found in `tests/env_templates`.
276
272
277
273
The general expectation is that idiomatic non-Admin tests, and vectorize in-depth tests, are
278
-
part of the main CI flow; conversely, core, admin and vectorize all-providers are kept as a
274
+
part of the main CI flow; conversely, admin and vectorize all-providers are kept as a
279
275
manual task to run (locally in most cases) when circumstances require it (use your judgement).
280
276
281
277
#### Required environment variables
@@ -286,13 +282,12 @@ of testing:
286
282
-**DockerCompose**: generally no variables needed, except:
287
283
-**vectorize in-depth**: provide as in `env.vectorize-minimal.template`
288
284
-**vectorize all-providers**: provide as in `env.vectorize.template`
289
-
- (also note that _core ops_ and _idiomatic admin Astra_amount to nothing in this case)
285
+
- (also note that _idiomatic admin Astra_amounts to nothing in this case)
290
286
-**nonAstra**: all tests require as in `env.local.template`, plus:
291
287
-**vectorize in-depth**: also provide as in `env.vectorize-minimal.template`
292
288
-**vectorize all-providers**: also provide as in `env.vectorize.template`
293
-
- (also note that _core ops_ and _idiomatic admin Astra_amount to nothing in this case)
289
+
- (also note that _idiomatic admin Astra_amounts to nothing in this case)
294
290
-**Astra**: all tests require as in `env.astra.template`, plus:
295
-
-**core ops**: the token must have at least "Database Administrator" role (possibly through definition of a separate `ASTRA_DB_OPS_APPLICATION_TOKEN`), and `ASTRA_DB_ID` must also be defined
296
291
-**idiomatic admin Astra**: also provide as in `env.astra.admin.template`
297
292
-**vectorize in-depth**: also provide as in `env.vectorize-minimal.template`
298
293
-**vectorize all-providers**: also provide as in `env.vectorize.template`
@@ -305,20 +300,6 @@ For the **DockerCompose** case, prepend all of the following with `DOCKER_COMPOS
305
300
All the usual `pytest` ways of restricting the test selection hold in addition
306
301
(e.g. `poetry run pytest tests/idiomatic/unit` or `[...] -k <test_name_selector>`).
307
302
308
-
##### _core regular_:
309
-
310
-
```
311
-
poetry run pytest tests/core
312
-
```
313
-
314
-
##### _core ops_:
315
-
316
-
Note the special variable needed to actually run this. You will have to manually clean up afterwards.
317
-
318
-
```
319
-
TEST_ASTRADBOPS="1" poetry run pytest tests/core/test_ops.py
320
-
```
321
-
322
303
##### _idiomatic regular_:
323
304
324
305
Warning: this will also trigger the very long-running _idiomatic admin Astra_ if the vars as in `env.astra.admin.template` are also detected. Likewise, the _idiomatic admin nonAstra_ may start (if `DO_IDIOMATIC_ADMIN_TESTS` is set), which however takes few seconds.
you are strongly advised to migrate to the current API. All of the astrapy pre-1.0 API (later dubbed "core")
496
+
works throughout *astrapy v1*, albeit with a deprecation warning on astrapy v. 1.5.
497
+
498
+
Version 2 drops "core" support entirely. In order to use astrapy version 2.0+, you need to migrate your application.
499
+
Check the links at the beginning of this README for the updated documentation and API reference.
588
500
501
+
Check out previous versions of this README for more on "core": [1.5.2](https://github.com/datastax/astrapy/blob/4601c5fa749925d961de1f114ca27690d1a71b13/README.md) and [pre-1.0](https://github.com/datastax/astrapy/blob/cd3f5ce8146093e10a095709c0f5c3f8e3f2c7da/README.md).
0 commit comments