Skip to main content

No project description provided

Project description

nucliadb

This module contains most of the Python components for NucliaDB:

  • ingest
  • reader
  • writer
  • search
  • train

NucliaDB Migrations

This module is used to manage NucliaDB Migrations.

All migrations will be provided in the migrations folder and have a filename that follows the structure: [sequence]_[migration name].py. Where sequence is the order the migration should be run in with zero padding. Example: 0001_migrate_data.py.

Each migration should have the following:

from nucliadb.migrator.context import ExecutionContext


async def migrate(context: ExecutionContext) -> None:
    """
    Non-kb type of migration. Migrate global data.
    """


async def migrate_kb(context: ExecutionContext, kbid: str) -> None:
    """
    Migrate kb.

    Must have both types of migrations.
    """

How migrations are managed

  • All migrations utilize a distributed lock to prevent simulateously running jobs

  • Global migration state:

    • current version
    • target version
    • KBs to migrate
  • KB Migration State:

    • current version
  • Migrations are currently run with a deployment and will be continuously retried on failure.

  • Running migrations in a deployment is to make sure a migration does not prevent code deployment.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

nucliadb-3.1.0.post511-py3-none-any.whl (763.4 kB view details)

Uploaded Python 3

File details

Details for the file nucliadb-3.1.0.post511-py3-none-any.whl.

File metadata

File hashes

Hashes for nucliadb-3.1.0.post511-py3-none-any.whl
Algorithm Hash digest
SHA256 fe09d6e10faa029e8f3a2305afb6132fcf4f8601d3e2cc52460bebc3cedf8344
MD5 27d7ddb4fcc289eaf486d043f2aa481e
BLAKE2b-256 bb19d14da7bcf5f8ea1e32dcef0c85aea0888f0ca3bdbf90f6c8ac084dce4024

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page