tenant_db/neon-provider

Classes

NeonTenantDbProvider

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

Implements

TenantDbProvider

Constructors

Constructor

new NeonTenantDbProvider(apiKey): NeonTenantDbProvider;

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

Parameters

Parameter	Type
`apiKey`	`string`

Returns

NeonTenantDbProvider

Methods

createBranch()

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

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

Parameters

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

Returns

Promise<NeonBranchConfig>

Implementation of

TenantDbProvider.createBranch

createOrgProject()

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

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

Parameters

Parameter	Type
`_orgId`	`string`
`orgName`	`string`

Returns

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

Implementation of

TenantDbProvider.createOrgProject

deleteBranch()

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

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

Parameters

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

Returns

Promise<void>

Implementation of

TenantDbProvider.deleteBranch

deleteOrgProject()

deleteOrgProject(projectId): Promise<void>;

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

Parameters

Parameter	Type
`projectId`	`string`

Returns

Promise<void>

Implementation of

TenantDbProvider.deleteOrgProject

ensureDevBranch()

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

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

Parameters

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

Returns

Promise<NeonBranchConfig>

Implementation of

TenantDbProvider.ensureDevBranch

getBranchConnectionString()

getBranchConnectionString(
   projectId, 
   branchId, 
opts?): Promise<string>;

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

Parameters

Parameter	Type
`projectId`	`string`
`branchId`	`string`
`opts?`	{ `referenceConnectionString?`: `string`; }
`opts.referenceConnectionString?`	`string`

Returns

Promise<string>

getProject()

getProject(projectId): Promise<{
  id: string;
  name: string;
}>;

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

Parameters

Parameter	Type
`projectId`	`string`

Returns

Promise<{ id: string; name: string; }>

listAllProjects()

listAllProjects(): Promise<NeonProjectSummary[]>;

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

List all projects accessible by the API key.

Returns

Promise<NeonProjectSummary[]>

listBranches()

listBranches(projectId): Promise<NeonListBranchesResponse>;

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

Parameters

Parameter	Type
`projectId`	`string`

Returns

Promise<NeonListBranchesResponse>

listProjectsByName()

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

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

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

Parameters

Parameter	Type
`name`	`string`

Returns

Promise<NeonProjectSummary[]>

Implementation of

TenantDbProvider.listProjectsByName

provisionOrgZones()

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

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

Parameters

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

Returns

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

Implementation of

TenantDbProvider.provisionOrgZones

resetBranchFromParent()

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

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

Parameters

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

Returns

Promise<void>

Implementation of

TenantDbProvider.resetBranchFromParent

resolveExistingOrgProject()

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

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

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>

Implementation of

TenantDbProvider.resolveExistingOrgProject

restoreBranch()

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

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

Parameters

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

Returns

Promise<{ backupBranchId: string; }>

Implementation of

TenantDbProvider.restoreBranch

restoreFromBranch()

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

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

Parameters

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

Returns

Promise<void>

Implementation of

TenantDbProvider.restoreFromBranch

Type Aliases

NeonProjectSummary

type NeonProjectSummary = object;

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

Properties

Property	Type	Defined in
`createdAt`	`string`	platform-utils/src/tenant_db/neon-provider.ts:59
`id`	`string`	platform-utils/src/tenant_db/neon-provider.ts:59
`name`	`string`	platform-utils/src/tenant_db/neon-provider.ts:59