Skip to main content

NucliaDB

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-6.6.1.post4672-py3-none-any.whl (683.7 kB view details)

Uploaded Python 3

File details

Details for the file nucliadb-6.6.1.post4672-py3-none-any.whl.

File metadata

File hashes

Hashes for nucliadb-6.6.1.post4672-py3-none-any.whl
Algorithm Hash digest
SHA256 bc6fe06c0f5542f048fb352b732cafd3437e9799afee69e6da15cd139e8534d7
MD5 dcaf473d0d8521bfe65e357d767aedf0
BLAKE2b-256 06d5259483cdf993a7bf82f978a61dbdac4cc3e34f0d5c0f1cfda843d87ba310

See more details on using hashes here.

Supported by

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