Skip to content
# Class: VacuumStatement

Defined in: packages/core/src/models/DDLStatements.ts:510

VACUUM statement representation.

Extends ​

Constructors ​

Constructor ​

new VacuumStatement(params?): VacuumStatement

Defined in: packages/core/src/models/DDLStatements.ts:518

Parameters ​

params? ​
full? ​

boolean

verbose? ​

boolean

freeze? ​

boolean

analyze? ​

boolean

targets? ​

QualifiedName[]

Returns ​

VacuumStatement

Overrides ​

SqlComponent.constructor

Properties ​

kind ​

static kind: symbol

Defined in: packages/core/src/models/DDLStatements.ts:511

Overrides ​

SqlComponent.kind


full ​

full: boolean

Defined in: packages/core/src/models/DDLStatements.ts:512


verbose ​

verbose: boolean

Defined in: packages/core/src/models/DDLStatements.ts:513


freeze ​

freeze: boolean

Defined in: packages/core/src/models/DDLStatements.ts:514


analyze ​

analyze: boolean

Defined in: packages/core/src/models/DDLStatements.ts:515


targets ​

targets: QualifiedName[]

Defined in: packages/core/src/models/DDLStatements.ts:516


comments ​

comments: string[] | null = null

Defined in: packages/core/src/models/SqlComponent.ts:29

Inherited from ​

SqlComponent.comments


positionedComments ​

positionedComments: PositionedComment[] | null = null

Defined in: packages/core/src/models/SqlComponent.ts:32

Inherited from ​

SqlComponent.positionedComments

Methods ​

getKind() ​

getKind(): symbol

Defined in: packages/core/src/models/SqlComponent.ts:15

Returns ​

symbol

Inherited from ​

SqlComponent.getKind


accept() ​

accept<T&gt;(visitor): T

Defined in: packages/core/src/models/SqlComponent.ts:19

Type Parameters ​

T ​

T

Parameters ​

visitor ​

SqlComponentVisitor<T&gt;

Returns ​

T

Inherited from ​

SqlComponent.accept


toSqlString() ​

toSqlString(formatter): string

Defined in: packages/core/src/models/SqlComponent.ts:23

Parameters ​

formatter ​

SqlComponentVisitor<string&gt;

Returns ​

string

Inherited from ​

SqlComponent.toSqlString


addPositionedComments() ​

addPositionedComments(position, comments): void

Defined in: packages/core/src/models/SqlComponent.ts:37

Add comments at a specific position

Parameters ​

position ​

"before" | "after"

comments ​

string[]

Returns ​

void

Inherited from ​

SqlComponent.addPositionedComments


getPositionedComments() ​

getPositionedComments(position): string[]

Defined in: packages/core/src/models/SqlComponent.ts:56

Get comments for a specific position

Parameters ​

position ​

"before" | "after"

Returns ​

string[]

Inherited from ​

SqlComponent.getPositionedComments


getAllPositionedComments() ​

getAllPositionedComments(): string[]

Defined in: packages/core/src/models/SqlComponent.ts:66

Get all positioned comments as a flat array in order (before, after)

Returns ​

string[]

Inherited from ​

SqlComponent.getAllPositionedComments

Released under the MIT License.