tenant_db/provider

Interfaces

BranchOptions

Defined in: platform-utils/src/tenant_db/provider.ts:7

Properties

expiresAt?

optional expiresAt?: Date;

Defined in: platform-utils/src/tenant_db/provider.ts:9

name?

optional name?: string;

Defined in: platform-utils/src/tenant_db/provider.ts:8

NeonBranchConfig

Defined in: platform-utils/src/tenant_db/provider.ts:1

Properties

branchId

branchId: string;

Defined in: platform-utils/src/tenant_db/provider.ts:3

connectionString

connectionString: string;

Defined in: platform-utils/src/tenant_db/provider.ts:4

projectId

projectId: string;

Defined in: platform-utils/src/tenant_db/provider.ts:2

RestorePointLsn

Defined in: platform-utils/src/tenant_db/provider.ts:16

Properties

lsn

lsn: string;

Defined in: platform-utils/src/tenant_db/provider.ts:17

RestorePointTimestamp

Defined in: platform-utils/src/tenant_db/provider.ts:12

Properties

timestamp

timestamp: string;

Defined in: platform-utils/src/tenant_db/provider.ts:13

TenantDbProvider

Defined in: platform-utils/src/tenant_db/provider.ts:20

Methods

createBranch()

createBranch(
   projectId, 
   parentBranchId, 
options?): Promise<NeonBranchConfig>;

Defined in: platform-utils/src/tenant_db/provider.ts:33

Parameters

Parameter	Type
`projectId`	`string`
`parentBranchId`	`string`
`options?`	`BranchOptions`

Returns

Promise<NeonBranchConfig>

createOrgProject()

createOrgProject(orgId, orgName): Promise<{
  mainBranch: NeonBranchConfig;
  projectId: string;
}>;

Defined in: platform-utils/src/tenant_db/provider.ts:21

Parameters

Parameter	Type
`orgId`	`string`
`orgName`	`string`

Returns

Promise<{ mainBranch: NeonBranchConfig; projectId: string; }>

deleteBranch()

deleteBranch(projectId, branchId): Promise<void>;

Defined in: platform-utils/src/tenant_db/provider.ts:38

Parameters

Parameter	Type
`projectId`	`string`
`branchId`	`string`

Returns

Promise<void>

deleteOrgProject()

deleteOrgProject(projectId): Promise<void>;

Defined in: platform-utils/src/tenant_db/provider.ts:25

Parameters

Parameter	Type
`projectId`	`string`

Returns

Promise<void>

ensureDevBranch()

ensureDevBranch(
   projectId, 
   previewBranchId, 
containerId): Promise<NeonBranchConfig>;

Defined in: platform-utils/src/tenant_db/provider.ts:58

Parameters

Parameter	Type
`projectId`	`string`
`previewBranchId`	`string`
`containerId`	`string`

Returns

Promise<NeonBranchConfig>

listProjectsByName()

listProjectsByName(name): Promise<object[]>;

Defined in: platform-utils/src/tenant_db/provider.ts:27

Dev cleanup — list Neon projects whose name exactly matches name.

Parameters

Parameter	Type
`name`	`string`

Returns

Promise<object[]>

provisionOrgZones()

provisionOrgZones(orgId, orgName): Promise<{
  live: NeonBranchConfig;
  projectId: string;
}>;

Defined in: platform-utils/src/tenant_db/provider.ts:50

Parameters

Parameter	Type
`orgId`	`string`
`orgName`	`string`

Returns

Promise<{ live: NeonBranchConfig; projectId: string; }>

resetBranchFromParent()

resetBranchFromParent(projectId, branchId): Promise<void>;

Defined in: platform-utils/src/tenant_db/provider.ts:39

Parameters

Parameter	Type
`projectId`	`string`
`branchId`	`string`

Returns

Promise<void>

resolveExistingOrgProject()

resolveExistingOrgProject(orgName): Promise<
  | {
  mainBranch: NeonBranchConfig;
  projectId: string;
}
| null>;

Defined in: platform-utils/src/tenant_db/provider.ts:29

Dev reset — reuse an existing org project when present instead of creating a new one.

Parameters

Parameter	Type
`orgName`	`string`

Returns

Promise< | { mainBranch: NeonBranchConfig; projectId: string; } | null>

restoreBranch()

restoreBranch(
   projectId, 
   branchId, 
   point, 
   preserveName?): Promise<{
  backupBranchId: string;
}>;

Defined in: platform-utils/src/tenant_db/provider.ts:41

Parameters

Parameter	Type
`projectId`	`string`
`branchId`	`string`
`point`	\| `RestorePointTimestamp` \| `RestorePointLsn`
`preserveName?`	`string`

Returns

Promise<{ backupBranchId: string; }>

restoreFromBranch()

restoreFromBranch(
   projectId, 
   branchId, 
sourceBranchName): Promise<void>;

Defined in: platform-utils/src/tenant_db/provider.ts:48

Parameters

Parameter	Type
`projectId`	`string`
`branchId`	`string`
`sourceBranchName`	`string`

Returns

Promise<void>