Class IndexMigrationGenerator

Index

Constructors

Methods

Generate CommentText IndexName Quote Timestamp

Constructors

constructor

new IndexMigrationGenerator(): IndexMigrationGenerator
Returns IndexMigrationGenerator

Methods

Generate

Generate(
data: IndexAdvisorData,
options: AutoDocExporterOptions,
): AutoDocExportFile[]
Returns the migration file (plus a Flyway .conf when PostgreSQL CONCURRENTLY is on), or nothing when there are no proposals.
Parameters
- data: IndexAdvisorData
- options: AutoDocExporterOptions
Returns AutoDocExportFile[]
- Defined in packages/DBAutoDoc/src/plugins/index-advisor/IndexMigrationGenerator.ts:17

`Static`CommentText

CommentText(text: string): string
Flattens text onto one line so it cannot end a -- comment and become executable SQL.
Parameters
- text: string
Returns string
- Defined in packages/DBAutoDoc/src/plugins/index-advisor/IndexMigrationGenerator.ts:50

`Static`IndexName

IndexName(
proposal: Pick<IndexProposal, "TableName" | "Columns">,
provider: "sqlserver" | "mysql" | "postgresql",
): string
Index name for a proposal: IX_
_
, shortened with a hash suffix when too long. PostgreSQL index names must be unique per schema, and the readable part is lossy (Order.Line_ID and Order_Line.ID both give IX_Order_Line_ID), so PostgreSQL names always carry a hash of the exact table and columns.
Parameters
proposal: Pick<IndexProposal, "TableName" | "Columns">
provider: "sqlserver" | "mysql" | "postgresql"
Returns string
Defined in packages/DBAutoDoc/src/plugins/index-advisor/IndexMigrationGenerator.ts:36
StaticQuote
Quote(
identifier: string,
provider: "sqlserver" | "mysql" | "postgresql",
): string
Quotes an identifier for the platform, doubling any embedded quote character.

Parameters
identifier: string
provider: "sqlserver" | "mysql" | "postgresql"
Returns string
Defined in packages/DBAutoDoc/src/plugins/index-advisor/IndexMigrationGenerator.ts:92
StaticTimestamp
Timestamp(iso: string): string
yyyyMMddHHmm (UTC) from an ISO timestamp.

Parameters
iso: string
Returns string
Defined in packages/DBAutoDoc/src/plugins/index-advisor/IndexMigrationGenerator.ts:55
Settings
Member Visibility
Protected
Inherited
External
Theme
On This Page
Constructors
constructor
Methods
Generate CommentText IndexName Quote Timestamp
Member Junction
Loading...
Generated using TypeDoc