coolipy.models.databases

Database models for the Coolify API.

Classes

class ClickhouseModelCreate (**data: Any)

Expand source code

class ClickhouseModelCreate(DatabaseBaseModel):
    """Create a ClickHouse database."""

Create a ClickHouse database.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

• DatabaseBaseModel
• CoolipyBaseModel
• pydantic.main.BaseModel

Class variables

var model_config

class DatabaseBackupCreate (**data: Any)

Expand source code

class DatabaseBackupCreate(CoolipyBaseModel):
    """Body for creating a scheduled backup configuration."""

    frequency: str | None = None
    enabled: bool | None = None
    save_s3: bool | None = None
    s3_storage_uuid: str | None = None
    databases_to_backup: str | None = None
    dump_all: bool | None = None
    backup_now: bool | None = None
    database_backup_retention_amount_locally: int | None = None
    database_backup_retention_days_locally: int | None = None
    database_backup_retention_max_storage_locally: float | None = None
    database_backup_retention_amount_s3: int | None = None
    database_backup_retention_days_s3: int | None = None
    database_backup_retention_max_storage_s3: float | None = None
    timeout: int | None = None

Body for creating a scheduled backup configuration.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

• CoolipyBaseModel
• pydantic.main.BaseModel

Class variables

var backup_now : bool | None

var database_backup_retention_amount_locally : int | None

var database_backup_retention_amount_s3 : int | None

var database_backup_retention_days_locally : int | None

var database_backup_retention_days_s3 : int | None

var database_backup_retention_max_storage_locally : float | None

var database_backup_retention_max_storage_s3 : float | None

var databases_to_backup : str | None

var dump_all : bool | None

var enabled : bool | None

var frequency : str | None

var model_config

var s3_storage_uuid : str | None

var save_s3 : bool | None

var timeout : int | None

class DatabaseBaseModel (**data: Any)

Expand source code

class DatabaseBaseModel(CoolipyBaseModel):
    """Shared fields for database create/update request bodies."""

    server_uuid: str | None = None
    project_uuid: str | None = None
    environment_name: str | None = None
    environment_uuid: str | None = None
    destination_uuid: str | None = None
    name: str | None = None
    description: str | None = None
    image: str | None = None
    is_public: bool | None = None
    public_port: int | None = None
    public_port_timeout: int | None = None
    limits_memory: str | None = None
    limits_memory_swap: str | None = None
    limits_memory_swappiness: int | None = None
    limits_memory_reservation: str | None = None
    limits_cpus: str | None = None
    limits_cpuset: str | None = None
    limits_cpu_shares: int | None = None
    instant_deploy: bool | None = None
    tags: list[str] | None = None
    postgres_user: str | None = None
    postgres_password: str | None = None
    postgres_db: str | None = None
    postgres_initdb_args: str | None = None
    postgres_host_auth_method: str | None = None
    postgres_conf: str | None = None
    clickhouse_admin_user: str | None = None
    clickhouse_admin_password: str | None = None
    dragonfly_password: str | None = None
    redis_password: str | None = None
    redis_conf: str | None = None
    keydb_password: str | None = None
    keydb_conf: str | None = None
    mariadb_conf: str | None = None
    mariadb_root_password: str | None = None
    mariadb_user: str | None = None
    mariadb_password: str | None = None
    mariadb_database: str | None = None
    mongo_conf: str | None = None
    mongo_initdb_root_username: str | None = None
    mongo_initdb_root_password: str | None = None
    mongo_initdb_database: str | None = None
    mysql_root_password: str | None = None
    mysql_password: str | None = None
    mysql_user: str | None = None
    mysql_database: str | None = None
    mysql_conf: str | None = None
    health_check_enabled: bool | None = None
    health_check_interval: int | None = None
    health_check_timeout: int | None = None
    health_check_retries: int | None = None
    health_check_start_period: int | None = None

Shared fields for database create/update request bodies.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

• CoolipyBaseModel
• pydantic.main.BaseModel

Subclasses

• ClickhouseModelCreate
• DatabaseModel
• DatabaseUpdateModel
• DragonflyModelCreate
• KeyDBModelCreate
• MariaDBModelCreate
• MongoDBModelCreate
• MySQLModelCreate
• PostgreSQLModelCreate
• RedisModelCreate

Class variables

var clickhouse_admin_password : str | None

var clickhouse_admin_user : str | None

var description : str | None

var destination_uuid : str | None

var dragonfly_password : str | None

var environment_name : str | None

var environment_uuid : str | None

var health_check_enabled : bool | None

var health_check_interval : int | None

var health_check_retries : int | None

var health_check_start_period : int | None

var health_check_timeout : int | None

var image : str | None

var instant_deploy : bool | None

var is_public : bool | None

var keydb_conf : str | None

var keydb_password : str | None

var limits_cpu_shares : int | None

var limits_cpus : str | None

var limits_cpuset : str | None

var limits_memory : str | None

var limits_memory_reservation : str | None

var limits_memory_swap : str | None

var limits_memory_swappiness : int | None

var mariadb_conf : str | None

var mariadb_database : str | None

var mariadb_password : str | None

var mariadb_root_password : str | None

var mariadb_user : str | None

var model_config

var mongo_conf : str | None

var mongo_initdb_database : str | None

var mongo_initdb_root_password : str | None

var mongo_initdb_root_username : str | None

var mysql_conf : str | None

var mysql_database : str | None

var mysql_password : str | None

var mysql_root_password : str | None

var mysql_user : str | None

var name : str | None

var postgres_conf : str | None

var postgres_db : str | None

var postgres_host_auth_method : str | None

var postgres_initdb_args : str | None

var postgres_password : str | None

var postgres_user : str | None

var project_uuid : str | None

var public_port : int | None

var public_port_timeout : int | None

var redis_conf : str | None

var redis_password : str | None

var server_uuid : str | None

var tags : list[str] | None

class DatabaseModel (**data: Any)

Expand source code

class DatabaseModel(DatabaseBaseModel):
    """A database as returned by the API."""

    id: int | None = None
    uuid: str | None = None
    status: str | None = None
    environment_id: int | None = None
    server_id: int | None = None
    destination_id: int | None = None
    destination_type: str | None = None
    internal_db_url: str | None = None
    created_at: datetime | None = None
    updated_at: datetime | None = None
    deleted_at: datetime | None = None

A database as returned by the API.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

• DatabaseBaseModel
• CoolipyBaseModel
• pydantic.main.BaseModel

Class variables

var created_at : datetime.datetime | None

var deleted_at : datetime.datetime | None

var destination_id : int | None

var destination_type : str | None

var environment_id : int | None

var id : int | None

var internal_db_url : str | None

var model_config

var server_id : int | None

var status : str | None

var updated_at : datetime.datetime | None

var uuid : str | None

class DatabaseUpdateModel (**data: Any)

Expand source code

class DatabaseUpdateModel(DatabaseBaseModel):
    """Body for updating a database."""

Body for updating a database.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

• DatabaseBaseModel
• CoolipyBaseModel
• pydantic.main.BaseModel

Class variables

var model_config

class DragonflyModelCreate (**data: Any)

Expand source code

class DragonflyModelCreate(DatabaseBaseModel):
    """Create a Dragonfly database."""

Create a Dragonfly database.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

• DatabaseBaseModel
• CoolipyBaseModel
• pydantic.main.BaseModel

Class variables

var model_config

class KeyDBModelCreate (**data: Any)

Expand source code

class KeyDBModelCreate(DatabaseBaseModel):
    """Create a KeyDB database."""

Create a KeyDB database.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

• DatabaseBaseModel
• CoolipyBaseModel
• pydantic.main.BaseModel

Class variables

var model_config

class MariaDBModelCreate (**data: Any)

Expand source code

class MariaDBModelCreate(DatabaseBaseModel):
    """Create a MariaDB database."""

Create a MariaDB database.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

• DatabaseBaseModel
• CoolipyBaseModel
• pydantic.main.BaseModel

Class variables

var model_config

class MongoDBModelCreate (**data: Any)

Expand source code

class MongoDBModelCreate(DatabaseBaseModel):
    """Create a MongoDB database."""

Create a MongoDB database.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

• DatabaseBaseModel
• CoolipyBaseModel
• pydantic.main.BaseModel

Class variables

var model_config

class MySQLModelCreate (**data: Any)

Expand source code

class MySQLModelCreate(DatabaseBaseModel):
    """Create a MySQL database."""

Create a MySQL database.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

• DatabaseBaseModel
• CoolipyBaseModel
• pydantic.main.BaseModel

Class variables

var model_config

class PostgreSQLModelCreate (**data: Any)

Expand source code

class PostgreSQLModelCreate(DatabaseBaseModel):
    """Create a PostgreSQL database."""

Create a PostgreSQL database.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

• DatabaseBaseModel
• CoolipyBaseModel
• pydantic.main.BaseModel

Class variables

var model_config

class RedisModelCreate (**data: Any)

Expand source code

class RedisModelCreate(DatabaseBaseModel):
    """Create a Redis database."""

Create a Redis database.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

• DatabaseBaseModel
• CoolipyBaseModel
• pydantic.main.BaseModel

Class variables

var model_config