Skip to content

Release v2.3.0

Choose a tag to compare

@github-actions github-actions released this 30 Jun 20:43
3570473

These release notes list changes compared to version 2.2.1 (previous stable).

What's Changed

Python version support

  • Dropped support for Python 3.9.
  • Supported versions are now 3.10 to 3.14.

Admin-related enrichments

  • AstraDBAdmin: support for listing PCU Groups:
    • Added PCUGroupDescriptor/PCUGroupTypeDescriptor/PCUGroupTypeDetailsDescriptor classes.
    • Added [async_]list_pcu_groups method.
  • AstraDBAdmin: [async_]find_available_regions method handles PCU Type info in response.
  • AstraDBAdmin.[async_]create_database, expanded expressivity:
    • expose more parameters (pcu group ID, tier, db type, capacity units) with a new DatabaseDefinition method parameter and call pattern.
    • the method cross-checks the validity of the provided PCU Group ID (if one is provided) before proceeding.
  • Removed the deprecated 'region_name' alias for name from AstraDBAdminDatabaseRegionInfo and AstraDBAvailableRegionInfo.

Generic client API

  • CollectionDefinition fluent interface: renamed all set_* methods to with_* (e.g., set_vector_dimension => with_vector_dimension):
    • Old set_* methods remain as deprecated aliases (deprecated in 2.3.0, will be removed in 3.0.0).
    • Affected methods: with_indexing, with_default_id, with_vector_dimension, with_vector_metric, with_vector_source_model, with_vector_service, with_rerank, with_lexical.
  • Added support for "Reranker Override" in the find_and_rerank method call.
  • Added support for custom CA certificates (PEM) in the APIOptions (new ca_cert_path parameter).
  • Bugfix: faulty normalization of empty/null indexing targets for CollectionDefinition.set_indexing.

Cursors, minor behaviour changes

  • has_next, called on an IDLE cursor, sets it to ACTIVE.
  • has_next may set the cursor to CLOSED if no next items are detected.

Development/maintenance

  • Integration tests have an embedding-provider switcher logic.
  • Integration tests use the latest HCD (2.0.6) and a recent Data API build (1.0.46).
  • Integration tests: configurable page size for find paginated operations.
  • Addressed all pending vulnerable dependencies as reported by Dependabot (e.g. idna, pygments, filelock, etc.).
  • Integration tests fail early if a non-empty database is detected (manually overridable with TOLERATE_POPULATED_DATABASE=yes env var).

Autogenerated changelog:

  • Upgrade CI/CD (replace OpenAI->Voyage; suppress OpenAI from extended vec.ze) by @sl-at-ibm in #415
  • Support for "Rerank override" Data API feature by @sl-at-ibm in #416
  • feat: Support for passing certificate path in httpx calls by @erichare in #409
  • fix: normalize set_indexing mode (lowercase key) and empty target ([]) for Data API by @erichare in #414
  • (minor) Forgot some (noncritical) rearranging of api options by @sl-at-ibm in #417
  • feat: Switch set_ to with_ and add deprecated alias by @erichare in #410
  • Enrich create_database method expressiveness by @sl-at-ibm in #421
  • chore: bump idna and pygments in uv.lock to clear Dependabot alerts by @erichare in #424
  • Full adaptation of CI/CD to parametrized FIND_PAGE_SIZE by @sl-at-ibm in #425
  • Issue 426: List PCU Groups and its impact on create_database by @sl-at-ibm in #427
  • Minor cursor behaviour improvements (+ testing) by @sl-at-ibm in #428
  • chore: require an empty target database for integration tests by @erichare in #423
  • Drop Python 3.9 support and refresh vulnerable deps by @erichare in #429
  • Remove deprecated region_name property alias by @sl-at-ibm in #430
  • Minor adjustments pre-v2.3 by @sl-at-ibm in #431

Full Changelog: v2.2.1...v2.3.0