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-5.0.1.post983-py3-none-any.whl (558.7 kB view details)

Uploaded Python 3

File details

Details for the file nucliadb-5.0.1.post983-py3-none-any.whl.

File metadata

File hashes

Hashes for nucliadb-5.0.1.post983-py3-none-any.whl
Algorithm Hash digest
SHA256 51160942f0e2c2ff784b4221b47a2132c9455b2b8fad3182b5309cfe6d1b363f
MD5 18baf594e2bd9d6e815cc39cddfa1ed1
BLAKE2b-256 a5016cb22ca53ee4aa50b6ca5480e87e2211d25fc31cb523ddb759da72d23874

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