[DOP-23620] Describe database structure

Author: dolfinus

docs/reference/database/index.rst

@@ -107,3 +107,4 @@ See also
 
     configuration
     credentials_encryption
+    structure

docs/reference/database/structure.rst

@@ -0,0 +1,126 @@
+.. _database-structure:
+
+Database structure
+==================
+
+.. https://plantuml.com/en/ie-diagram
+
+.. plantuml::
+
+    @startuml
+    title Database structure
+
+    entity user {
+        * id: bigint
+        ----
+        * username: varchar(256)
+        email: varchar(256) null
+        first_name: varchar(256) null
+        last_name: varchar(256) null
+        middle_name: varchar(256) null
+        is_superuser: boolean
+        is_active: boolean
+        created_at: timestamp
+        updated_at: timestamp
+        is_deleted: boolean
+    }
+
+    entity group {
+        * id: bigint
+        ----
+        name: varchar(256)
+        description: varchar(512)
+        owner_id: bigint
+        created_at: timestamptz
+        updated_at: timestamptz
+        search_vector: tsquery
+    }
+
+    entity user_group {
+        * user_id: bigint
+        * group_id: bigint
+        ----
+        role_id: varchar(255)
+    }
+
+    entity connection {
+        * id: bigint
+        ----
+        * group_id: bigint
+        type: varchar(23)
+        name: varchar(123)
+        description: varchar(512)
+        data: json
+        created_at: timestamptz
+        updated_at: timestamptz
+        search_vector: tsquery
+    }
+
+    entity auth_data {
+        * connection_id: bigint
+        ----
+        value: text
+        created_at: timestamptz
+        updated_at: timestamptz
+    }
+
+    entity queue {
+        * id: bigint
+        ----
+        name: varchar(128)
+        slut: varchar(256)
+        * group_id: bigint
+        description: varchar(512)
+        created_at: timestamptz
+        updated_at: timestamptz
+    }
+
+    entity transfer {
+        * id: bigint
+        ----
+        * group_id: bigint
+        name: varchar(128)
+        * source_connection_id: bigint
+        * target_connection_id: bigint
+        strategy_params: json
+        target_params: json
+        transformations: json
+        resources: json
+        is_scheduled: boolean
+        schedule: varchar(32)
+        * queue_id: bigint
+        created_at: timestamptz
+        updated_at: timestamptz
+    }
+
+    entity run {
+        * id: bigint
+        ----
+        * transfer_id
+        started_at: timestamptz
+        ended_at: timestamptz
+        status: varchar(255)
+        type: varchar(64)
+        log_url: varchar(512)
+        transfer_dump: json
+        created_at: timestamptz
+        updated_at: timestamptz
+    }
+
+    user_group ||--o{ user
+    user_group ||--o{ group
+
+    group "owner_id" ||--o{ user
+
+    queue ||--o{ group
+
+    connection ||--o{ group
+    auth_data ||--o{ connection
+
+    transfer ||--o{ queue
+    transfer ||--o{ connection
+    transfer ||--o{ group
+
+    run ||--o{ transfer
+
+    @enduml