Django

Django is a popular Python web framework with a powerful ORM for working with databases.

YDB supports integration with Django through a special django-ydb-backend backend, which provides full Django ORM support for working with YDB.

Quick Start

Installation

Install the django-ydb-backend package using pip:

pip install django-ydb-backend

Connection Setup

Add YDB to your Django settings in settings.py:

DATABASES = {
    "default": {
        "NAME": "ydb_db",
        "ENGINE": "ydb_backend.backend",
        "HOST": "localhost",
        "PORT": "2136",
        "DATABASE": "/local",
    }
}

Configuration

DATABASES

Required parameters:

• NAME (required): traditional Django database name
• ENGINE (required): must be set to ydb_backend.backend
• HOST (required): hostname or IP address of the YDB server (e.g., "localhost")
• PORT (required): gRPC port YDB is running on (default is 2136)
• DATABASE (required): full path to your YDB database (e.g., "/local" for local testing or "/my_production_db")

DATABASES = {
    "default": {
        "NAME": "ydb_db",
        "ENGINE": "ydb_backend.backend",
        "HOST": "localhost",
        "PORT": "2136",
        "DATABASE": "/local",
    }
}

Authentication Methods

Anonymous Authentication

To use anonymous authentication, you don't need to pass any additional parameters.

Static Authentication

To use static credentials, you should provide username and password:

DATABASES = {
    "default": {
        "ENGINE": "ydb_backend.backend",
        "CREDENTIALS": {
            "username": "...",
            "password": "..."
        }
    }
}

Token Authentication

To use access token credentials, you should provide token:

DATABASES = {
    "default": {
        "ENGINE": "ydb_backend.backend",
        "CREDENTIALS": {
            "token": "..."
        },
    }
}

Service Account Authentication

To use service account credentials, you should provide service_account_json:

DATABASES = {
    "default": {
        "ENGINE": "ydb_backend.backend",
        "CREDENTIALS": {
            "service_account_json": {
                "id": "...",
                "service_account_id": "...",
                "created_at": "...",
                "key_algorithm": "...",
                "public_key": "...",
                "private_key": "..."
            }
        }
    }
}

Django Fields

YDB backend supports Django builtin fields.

Note: ForeignKey, ManyToManyField or even OneToOneField could be used with YDB backend. However, it's important to note that these relationships won't enforce database-level constraints, which may lead to potential data consistency issues.

Supported Django Fields

Useful Links

• Examples on GitHub
• PyPI Package