Documentation / @tenancy-node/db / DatabaseAdmin

Interface: DatabaseAdmin

Defined in: db/src/database-plugin.ts:125

Properties

servers

servers: object

Defined in: db/src/database-plugin.ts:134

add()

add(input): Promise<DatabaseServer>

Parameters

input

AddServerInput

Returns

Promise<DatabaseServer>

list()

list(): Promise<DatabaseServer[]>

Returns

Promise<DatabaseServer[]>

Methods

central()

central(): CentralAccess

Defined in: db/src/database-plugin.ts:144

Base central para plugins (outbox, webhooks, admin).

Returns

CentralAccess

---

connection()

connection(): TenantConnectionInfo

Defined in: db/src/database-plugin.ts:146

Conexión del tenant del contexto actual (síncrono).

Returns

TenantConnectionInfo

---

connectionUrl()

connectionUrl(tenant): Promise<string>

Defined in: db/src/database-plugin.ts:148

URL de conexión a la base del tenant (con sus credenciales), para herramientas externas.

Parameters

tenant

string

Returns

Promise<string>

---

install()

install(): Promise<MigrationRun>

Defined in: db/src/database-plugin.ts:127

Crea (o actualiza) las tablas tenancy_* y registra el servidor por defecto. Idempotente.

Returns

Promise<MigrationRun>

---

migrate()

migrate(options?): Promise<RunForEachResult>

Defined in: db/src/database-plugin.ts:130

Parameters

options?

MigrateOptions

Returns

Promise<RunForEachResult>

---

migrateCentral()

migrateCentral(): Promise<MigrationRun>

Defined in: db/src/database-plugin.ts:129

Tus migraciones centrales.

Returns

Promise<MigrationRun>

---

move()

move(tenant, options): Promise<MoveResult>

Defined in: db/src/database-plugin.ts:161

Mueve la base del tenant a otro servidor (con el tenant en mantenimiento mientras tanto). El origen se conserva salvo dropSource: true. Solo MySQL/MariaDB y PostgreSQL.

Parameters

tenant

string

options

MoveOptions

Returns

Promise<MoveResult>

---

pools()

pools(): PoolStats

Defined in: db/src/database-plugin.ts:154

Métricas de los pools abiertos.

Returns

PoolStats

---

provisioningSteps()

provisioningSteps(tenant): Promise<ProvisioningStepRecord[]>

Defined in: db/src/database-plugin.ts:150

Historial de aprovisionamiento del tenant.

Parameters

tenant

string

Returns

Promise<ProvisioningStepRecord[]>

---

rollback()

rollback(options?): Promise<RunForEachResult>

Defined in: db/src/database-plugin.ts:131

Parameters

options?

MigrateOptions & object

Returns

Promise<RunForEachResult>

---

rotateKey()

rotateKey(): Promise<{ updated: number; }>

Defined in: db/src/database-plugin.ts:156

Vuelve a cifrar con la llave actual todos los secretos guardados.

Returns

Promise<{ updated: number; }>

---

schema()

schema(format): Promise<string>

Defined in: db/src/database-plugin.ts:152

Modelos de las tablas tenancy_* para tu ORM (lee la estructura real de la base central).

Parameters

format

SchemaFormat

Returns

Promise<string>

---

seed()

seed(options?): Promise<RunForEachResult>

Defined in: db/src/database-plugin.ts:132

Parameters

options?

MigrateOptions

Returns

Promise<RunForEachResult>

---

status()

status(tenant): Promise<MigrationStatus[]>

Defined in: db/src/database-plugin.ts:133

Parameters

tenant

string

Returns

Promise<MigrationStatus[]>

---

tables()

tables(): Promise<object[]>

Defined in: db/src/database-plugin.ts:142

Tablas de la base del tenant actual (sin las de control de migraciones). En modo schema, solo las del schema del tenant: nunca las de otros tenants.

Returns

Promise<object[]>