diff --git a/docs/classes/Generator.html b/docs/classes/Generator.html index 5335b49..668091b 100644 --- a/docs/classes/Generator.html +++ b/docs/classes/Generator.html @@ -31,7 +31,7 @@

Hierarchy

+
  • Defined in src/generator.ts:74
    • @@ -120,7 +120,7 @@

    Parameters

    opts: GeneratorOpts

    Returns Generator

    +
  • Defined in src/generator.ts:81

    • Properties

    @@ -135,7 +135,7 @@

    Type declaration

  • Returns Promise<HandlebarsTemplateDelegate<any>>

    • +
  • Defined in src/generator.ts:94

    • Protected getFieldMappings

    getFieldMappings: (() => {
        columnName?: null | string | RegExp;
        columnType?: null | string | RegExp;
        comment?: null | string;
        generatedField: Object;
        tableName?: null | string | RegExp;
    }[]) & MemoizedFunction = ...
    @@ -148,7 +148,7 @@

    Type declaration

  • Returns {
        columnName?: null | string | RegExp;
        columnType?: null | string | RegExp;
        comment?: null | string;
        generatedField: Object;
        tableName?: null | string | RegExp;
    }[]

    • +
  • Defined in src/generator.ts:86

    • Protected getTemplatePath

    getTemplatePath: (() => string) & MemoizedFunction = ...
    @@ -161,27 +161,27 @@

    Type declaration

  • Returns string

    • +
  • Defined in src/generator.ts:90

    • logger

    logger: Logger = console
    +
  • Defined in src/generator.ts:79

    • Protected naming

    naming: NamingOptions
    +
  • Defined in src/generator.ts:76

    • Protected opts

    opts: GeneratorOpts
    +
  • Defined in src/generator.ts:75

    • Private writtenFiles

    writtenFiles: Set<string> = ...
    +
  • Defined in src/generator.ts:78

    • Methods

    @@ -198,7 +198,7 @@
    imports: defaultImports: Map<string, Set<string>>

    Returns ImportTmplInput[]

    +
  • Defined in src/generator.ts:364

    • Protected doesColumnHaveDefault

    Returns boolean

    +
  • Defined in src/generator.ts:575

    • Protected extractTableName

    Returns string

    +
  • Defined in src/generator.ts:703

    • Protected findPrimaryKey

    Returns null | {
        comment?: null | string;
        default?: any;
        name: string;
        nullable?: boolean;
        type: string;
    }

    +
  • Defined in src/generator.ts:673

    • Protected formatComment

    Returns null | string

    +
  • Defined in src/generator.ts:325

    • generate

    +
  • Defined in src/generator.ts:99

    • Protected generateTableMapper

    Returns Promise<void>

    +
  • Defined in src/generator.ts:289

    • Protected getAdapterImportPath

    Returns string

    +
  • Defined in src/generator.ts:449

    • Protected getAdapterImports

    Returns ImportTmplInput[]

    +
  • Defined in src/generator.ts:345

    • Private getCamelCasedTableName

    Returns string

    +
  • Defined in src/generator.ts:544

    • Protected getColComment

    Returns undefined | string

    +
  • Defined in src/generator.ts:606

    • Protected getColMappingInput

    Returns any

    +
  • Defined in src/generator.ts:836

    • Protected getColMappingObjName

    Returns string

    +
  • Defined in src/generator.ts:743

    • Protected getColSetName

    Returns null | string

    +
  • Defined in src/generator.ts:824

    • Protected getColumnsObjectName

    Returns string

    +
  • Defined in src/generator.ts:518

    • Protected getConnectionSourceImportPath

    Returns string

    +
  • Defined in src/generator.ts:334

    • Protected getCrudRepoName

    Returns string

    +
  • Defined in src/generator.ts:484

    • Protected getFieldInput

    +
  • Defined in src/generator.ts:212

    • Protected getFieldNameForColumn

    Returns string

    +
  • Defined in src/generator.ts:617

    • Protected getFieldType

    Returns GeneratedFieldType

    +
  • Defined in src/generator.ts:631

    • Protected getFieldsInput

    Returns FieldTmplInput[]

    +
  • Defined in src/generator.ts:204

    • Protected getIdPrefix

    Returns undefined | null | string

    +
  • Defined in src/generator.ts:313

    • Protected getImportPathForOutputPath

    Returns string

    +
  • Defined in src/generator.ts:432

    • Protected getInsertableRowTypeName

    Returns string

    +
  • Defined in src/generator.ts:713

    • Protected getInsertableValuesTypeName

    Returns string

    +
  • Defined in src/generator.ts:731

    • Protected getOutputFileName

    Returns string

    +
  • Defined in src/generator.ts:669

    • Protected getOutputFilePath

    Returns string

    +
  • Defined in src/generator.ts:664

    • Private getPascalCasedTableName

    Returns string

    +
  • Defined in src/generator.ts:540

    • Protected getRepoInput

    Returns null | RepoInput

    +
  • Defined in src/generator.ts:256

    • Protected getRowTypeInputs

    Returns any

    +
  • Defined in src/generator.ts:764

    • Protected getRowTypePrefix

    Returns string

    +
  • Defined in src/generator.ts:502

    • Protected getSelectedRowTypeName

    Returns string

    +
  • Defined in src/generator.ts:707

    • Protected getSelectedValuesTypeName

    Returns string

    +
  • Defined in src/generator.ts:725

    • Protected getTableKind

    Returns null | TableKind

    +
  • Defined in src/generator.ts:140

    • Protected getTableMapperClassName

    Returns string

    +
  • Defined in src/generator.ts:490

    • Protected getTableMapperInstName

    Returns null | string

    +
  • Defined in src/generator.ts:830

    • Protected getTableMapperInstanceName

    Returns string

    +
  • Defined in src/generator.ts:506

    • Protected getTableTemplateInput

    Returns Promise<any>

    +
  • Defined in src/generator.ts:149

    • Protected getTypeImports

    Returns ImportTmplInput[]

    +
  • Defined in src/generator.ts:384

    • Protected getTypeWrapper

    Returns undefined | {
        importPath?: null | string;
        isDefault?: null | boolean;
        isRelative?: null | boolean;
        name: string;
    }

    +
  • Defined in src/generator.ts:695

    • Protected getUpdatableRowTypeName

    Returns string

    +
  • Defined in src/generator.ts:719

    • Protected getUpdatableValuesTypeName

    Returns string

    +
  • Defined in src/generator.ts:737

    • Protected getUtilImports

    Returns ImportTmplInput[]

    +
  • Defined in src/generator.ts:420

    • Protected getValuesTypeInputs

    Returns any

    +
  • Defined in src/generator.ts:795

    • Protected getWrappedTypeInput

    +
  • Defined in src/generator.ts:747

    • Protected isColumnComputed

    Returns boolean

    +
  • Defined in src/generator.ts:591

    • Protected isColumnOmitted

    Returns boolean

    +
  • Defined in src/generator.ts:548

    • Protected isColumnOptional

    Returns boolean

    +
  • Defined in src/generator.ts:559

    • Protected postProcessOutput

    Returns Promise<string>

    +
  • Defined in src/generator.ts:473

    • Protected preProcessTemplateInput

    Returns Promise<any>

    +
  • Defined in src/generator.ts:469

    • Protected shouldProcess

    Returns boolean

    +
  • Defined in src/generator.ts:119

    • Protected wrapType

    Returns string

    +
  • Defined in src/generator.ts:690
    • diff --git a/docs/interfaces/CommonCustomTypesOptions.html b/docs/interfaces/CommonCustomTypesOptions.html index 8954559..fc449c9 100644 --- a/docs/interfaces/CommonCustomTypesOptions.html +++ b/docs/interfaces/CommonCustomTypesOptions.html @@ -22,7 +22,7 @@

    Hierarchy

    • CommonCustomTypesOptions
    +
  • Defined in src/generator-options.ts:269
    • @@ -43,8 +43,8 @@

    importPath

    +
  • Defined in src/generator-options.ts:266
    • +
  • Defined in src/generator-options.ts:266
    • diff --git a/docs/interfaces/CommonOptions.html b/docs/interfaces/CommonOptions.html index 3223153..e1a8887 100644 --- a/docs/interfaces/CommonOptions.html +++ b/docs/interfaces/CommonOptions.html @@ -22,7 +22,7 @@

    Hierarchy

    • CommonOptions
    +
  • Defined in src/generator-options.ts:283
    • @@ -53,7 +53,7 @@

    See

    CommonCustomTypesOptions

    +
  • Defined in src/generator-options.ts:274

    • Optional primaryKey

    primaryKey?: null | {
        isAutoGenerated?: null | boolean;
        name?: null | string;
    } = ...
    @@ -75,7 +75,7 @@

    See

    CommonCustomTypesOptions

    +
  • Defined in src/generator-options.ts:280

    • Optional typeAdapter

    typeAdapter?: null | {
        importPath: string;
    } = ...
    @@ -93,7 +93,7 @@

    See

    CommonPrimaryKeyOptions

    +
  • Defined in src/generator-options.ts:277
    • diff --git a/docs/interfaces/CommonPrimaryKeyOptions.html b/docs/interfaces/CommonPrimaryKeyOptions.html index f62576b..f31a17b 100644 --- a/docs/interfaces/CommonPrimaryKeyOptions.html +++ b/docs/interfaces/CommonPrimaryKeyOptions.html @@ -22,7 +22,7 @@

    Hierarchy

    • CommonPrimaryKeyOptions
    +
  • Defined in src/generator-options.ts:257
    • @@ -43,7 +43,7 @@

    Optional

    +
  • Defined in src/generator-options.ts:254

    • Optional name

    name?: null | string = ...
    @@ -52,7 +52,7 @@

    Optional

    +
  • Defined in src/generator-options.ts:250
    • diff --git a/docs/interfaces/CommonTypeAdapterOptions.html b/docs/interfaces/CommonTypeAdapterOptions.html index 671be8e..28198e1 100644 --- a/docs/interfaces/CommonTypeAdapterOptions.html +++ b/docs/interfaces/CommonTypeAdapterOptions.html @@ -22,7 +22,7 @@

    Hierarchy

    • CommonTypeAdapterOptions
    +
  • Defined in src/generator-options.ts:229
    • @@ -43,8 +43,8 @@

    importPath

    +
  • Defined in src/generator-options.ts:226
    • +
  • Defined in src/generator-options.ts:226
    • diff --git a/docs/interfaces/ExportOptions.html b/docs/interfaces/ExportOptions.html index 98910c1..74bb074 100644 --- a/docs/interfaces/ExportOptions.html +++ b/docs/interfaces/ExportOptions.html @@ -22,7 +22,7 @@

    Hierarchy

    • ExportOptions
    +
  • Defined in src/generator-options.ts:112
    • @@ -54,8 +54,8 @@

    columnTypeMappingInterface

    +
  • Defined in src/generator-options.ts:102
    • +
  • Defined in src/generator-options.ts:102

    • crudRepository

    crudRepository: boolean = ...
    @@ -65,8 +65,8 @@

    crudRepository

    +
  • Defined in src/generator-options.ts:109
    • +
  • Defined in src/generator-options.ts:109

    • extractedColumns

    extractedColumns: boolean = ...
    @@ -77,8 +77,8 @@

    extractedColumns

    +
  • Defined in src/generator-options.ts:90
    • +
  • Defined in src/generator-options.ts:90

    • rowTypes

    rowTypes: boolean = ...
    @@ -91,8 +91,8 @@

    rowTypes

    +
  • Defined in src/generator-options.ts:59
    • +
  • Defined in src/generator-options.ts:59

    • tableClasses

    tableClasses: boolean = ...
    @@ -103,8 +103,8 @@

    tableClasses

    +
  • Defined in src/generator-options.ts:36
    • +
  • Defined in src/generator-options.ts:36

    • tableInstances

    tableInstances: boolean = ...
    @@ -117,8 +117,8 @@

    tableInstances

    +
  • Defined in src/generator-options.ts:28
    • +
  • Defined in src/generator-options.ts:28

    • valuesTypes

    valuesTypes: boolean = ...
    @@ -131,8 +131,8 @@

    valuesTypes

    +
  • Defined in src/generator-options.ts:82
    • +
  • Defined in src/generator-options.ts:82
    • diff --git a/docs/interfaces/FieldMapping.html b/docs/interfaces/FieldMapping.html index f3398cb..2f468fa 100644 --- a/docs/interfaces/FieldMapping.html +++ b/docs/interfaces/FieldMapping.html @@ -22,7 +22,7 @@

    Hierarchy

    • FieldMapping
    +
  • Defined in src/field-mappings.ts:129
    • @@ -46,7 +46,7 @@

    Optional

    +
  • Defined in src/field-mappings.ts:105

    • Optional columnType

    columnType?: null | string | RegExp = ...
    @@ -57,13 +57,13 @@

    Optional

    +
  • Defined in src/field-mappings.ts:116

    • Optional comment

    comment?: null | string = ...
    +
  • Defined in src/field-mappings.ts:126

    • generatedField

    generatedField: Object = ...
    @@ -74,8 +74,8 @@

    generatedField

    +
  • Defined in src/field-mappings.ts:124
    • +
  • Defined in src/field-mappings.ts:124

    • Optional tableName

    tableName?: null | string | RegExp = ...
    @@ -84,7 +84,7 @@

    Optional

    +
  • Defined in src/field-mappings.ts:108
    • diff --git a/docs/interfaces/GeneratedField.html b/docs/interfaces/GeneratedField.html index 5e31092..8bfc3d0 100644 --- a/docs/interfaces/GeneratedField.html +++ b/docs/interfaces/GeneratedField.html @@ -27,7 +27,7 @@

    Hierarchy

    • GeneratedField
    +
  • Defined in src/field-mappings.ts:101
    • @@ -48,25 +48,25 @@

    OptionalhasDefault?: null | boolean = ...

    +
  • Defined in src/field-mappings.ts:93

    • Optional isComputed

    isComputed?: null | boolean = ...
    +
  • Defined in src/field-mappings.ts:91

    • Optional isOptional

    isOptional?: null | boolean = ...
    +
  • Defined in src/field-mappings.ts:92

    • Optional name

    name?: null | string = ...
    +
  • Defined in src/field-mappings.ts:90

    • Optional type

    type?: null | {
        adapter?: null | ({ name: string; importPath?: string | null | undefined; isDefault?: boolean | null | undefined; isRelative?: boolean | null | undefined; });
        dbType?: null | ({ name: string; });
        kind?: null | "custom" | "customComparable" | "enum";
        tsType?: null | ({ name: string; importPath?: string | null | undefined; isDefault?: boolean | null | undefined; isRelative?: boolean | null | undefined; });
    } = ...
    @@ -100,7 +100,7 @@
    Optional
    +
  • Defined in src/field-mappings.ts:89
    • diff --git a/docs/interfaces/GeneratedFieldType.html b/docs/interfaces/GeneratedFieldType.html index bfd742f..08f8a4c 100644 --- a/docs/interfaces/GeneratedFieldType.html +++ b/docs/interfaces/GeneratedFieldType.html @@ -22,7 +22,7 @@

    Hierarchy

    • GeneratedFieldType
    +
  • Defined in src/field-mappings.ts:85
    • @@ -75,7 +75,7 @@
    name
    +
  • Defined in src/field-mappings.ts:82

    • Optional dbType

    dbType?: null | {
        name: string;
    } = ...
    @@ -90,7 +90,7 @@
    name
    +
  • Defined in src/field-mappings.ts:66

    • Optional kind

    kind?: null | "custom" | "customComparable" | "enum" = ...
    @@ -99,7 +99,7 @@

    Optional

    +
  • Defined in src/field-mappings.ts:60

    • Optional tsType

    tsType?: null | {
        importPath?: null | string;
        isDefault?: null | boolean;
        isRelative?: null | boolean;
        name: string;
    } = ...
    @@ -140,7 +140,7 @@
    name
    +
  • Defined in src/field-mappings.ts:75
    • diff --git a/docs/interfaces/GeneratorOpts.html b/docs/interfaces/GeneratorOpts.html index 678986e..64b2d98 100644 --- a/docs/interfaces/GeneratorOpts.html +++ b/docs/interfaces/GeneratorOpts.html @@ -26,7 +26,7 @@

    Hierarchy

    • GeneratorOpts
    +
  • Defined in src/generator-options.ts:409
    • @@ -79,7 +79,7 @@

    See

    CommonPrimaryKeyOptions

    +
  • Defined in src/generator-options.ts:357

    • connectionSourcePath

    connectionSourcePath: string = ...
    @@ -88,8 +88,8 @@

    connectionSourcePath

    +
  • Defined in src/generator-options.ts:311
    • +
  • Defined in src/generator-options.ts:311

    • Optional dryRun

    dryRun?: null | boolean = ...
    @@ -98,7 +98,7 @@

    Optional

    +
  • Defined in src/generator-options.ts:302

    • Optional export

    export?: null | {
        columnTypeMappingInterface?: boolean;
        crudRepository?: boolean;
        extractedColumns?: boolean;
        rowTypes?: boolean;
        tableClasses?: boolean;
        tableInstances?: boolean;
        valuesTypes?: boolean;
    } = ...
    @@ -170,7 +170,7 @@

    See

    ExportOptions

    +
  • Defined in src/generator-options.ts:349

    • Optional fieldMappings

    fieldMappings?: null | {
        columnName?: null | string | RegExp;
        columnType?: null | string | RegExp;
        comment?: null | string;
        generatedField: Object;
        tableName?: null | string | RegExp;
    }[] = ...
    @@ -181,7 +181,7 @@

    See

    FieldMapping

    +
  • Defined in src/generator-options.ts:327

    • Optional includeDBTypeWhenIsOptional

    includeDBTypeWhenIsOptional?: null | boolean = ...
    @@ -192,7 +192,7 @@

    Optional

    +
  • Defined in src/generator-options.ts:371

    • Optional naming

    naming?: null | {
        columnTypeMappingInterfaceNameSuffix?: string;
        crudRepositoryClassNamePrefix?: string;
        crudRepositoryClassNameSuffix?: string;
        insertableRowTypeNamePrefix?: string;
        insertableRowTypeNameSuffix?: string;
        insertableValuesTypeNamePrefix?: string;
        insertableValuesTypeNameSuffix?: string;
        selectedRowTypeNamePrefix?: string;
        selectedRowTypeNameSuffix?: string;
        selectedValuesTypeNamePrefix?: string;
        selectedValuesTypeNameSuffix?: string;
        tableClassNamePrefix?: string;
        tableClassNameSuffix?: string;
        tableColumnsNamePrefix?: string;
        tableColumnsNameSuffix?: string;
        tableInstanceNamePrefix?: string;
        tableInstanceNameSuffix?: string;
        updatableRowTypeNamePrefix?: string;
        updatableRowTypeNameSuffix?: string;
        updatableValuesTypeNamePrefix?: string;
        updatableValuesTypeNameSuffix?: string;
        viewClassNamePrefix?: string;
        viewClassNameSuffix?: string;
        viewColumnsNamePrefix?: string;
        viewColumnsNameSuffix?: string;
        viewInstanceNamePrefix?: string;
        viewInstanceNameSuffix?: string;
    } = ...
    @@ -331,7 +331,7 @@
    Optional
    +
  • Defined in src/generator-options.ts:364

    • outputDirPath

    outputDirPath: string = ...
    @@ -340,8 +340,8 @@

    outputDirPath

    +
  • Defined in src/generator-options.ts:317
    • +
  • Defined in src/generator-options.ts:317

    • Optional rawContent

    rawContent?: null | {
        after?: null | string;
        before?: null | string;
    } = ...
    @@ -366,7 +366,7 @@

    See

    RawContent

    +
  • Defined in src/generator-options.ts:393

    • Optional removeExtraneous

    removeExtraneous?: null | "never" | "interactively" | "all" = ...
    @@ -379,7 +379,7 @@

    Optional

    +
  • Defined in src/generator-options.ts:381

    • schemaPath

    schemaPath: string = ...
    @@ -388,8 +388,8 @@

    schemaPath

    +
  • Defined in src/generator-options.ts:305
    • +
  • Defined in src/generator-options.ts:305

    • Optional tableMapping

    tableMapping?: null | {
        idPrefix?: null | string;
        useQualifiedTableName?: null | boolean;
    } = ...
    @@ -414,7 +414,7 @@

    See

    TableMapping

    +
  • Defined in src/generator-options.ts:334

    • Optional tables

    tables?: null | {
        exclude?: null | (string | RegExp)[];
        include?: null | (string | RegExp)[];
    } = ...
    @@ -441,7 +441,7 @@

    See

    TableInclusion

    +
  • Defined in src/generator-options.ts:342

    • Optional typeWrappers

    typeWrappers?: null | {
        typeName: Object;
        wrapper: { name: string; importPath?: string | null | undefined; isDefault?: boolean | null | undefined; isRelative?: boolean | null | undefined; };
    }[] = ...
    @@ -454,7 +454,7 @@

    See

    TypeWapper

    +
  • Defined in src/generator-options.ts:403
    • diff --git a/docs/interfaces/ImportedItem.html b/docs/interfaces/ImportedItem.html index e422a7b..3244444 100644 --- a/docs/interfaces/ImportedItem.html +++ b/docs/interfaces/ImportedItem.html @@ -38,7 +38,7 @@

    Hierarchy

    • ImportedItem
    +
  • Defined in src/field-mappings.ts:54
    • @@ -61,7 +61,7 @@

    Optional

    +
  • Defined in src/field-mappings.ts:16

    • Optional isDefault

    isDefault?: null | boolean = ...
    @@ -73,7 +73,7 @@

    Default

    false
    +
  • Defined in src/field-mappings.ts:23

    • Optional isRelative

    isRelative?: null | boolean = ...
    @@ -85,7 +85,7 @@

    Default

    true
    +
  • Defined in src/field-mappings.ts:30

    • name

    name: string = ...
    @@ -94,8 +94,8 @@

    name

    +
  • Defined in src/field-mappings.ts:13
    • +
  • Defined in src/field-mappings.ts:13
    • diff --git a/docs/interfaces/TableInclusion.html b/docs/interfaces/TableInclusion.html index f4cc696..4dde26c 100644 --- a/docs/interfaces/TableInclusion.html +++ b/docs/interfaces/TableInclusion.html @@ -22,7 +22,7 @@

    Hierarchy

    • TableInclusion
    +
  • Defined in src/generator-options.ts:17
    • @@ -44,7 +44,7 @@

    Optional

    +
  • Defined in src/generator-options.ts:14

    • Optional include

    include?: null | (string | RegExp)[] = ...
    @@ -54,7 +54,7 @@

    Optional

    +
  • Defined in src/generator-options.ts:9
    • diff --git a/docs/types/StrOrRegExp.html b/docs/types/StrOrRegExp.html index e5ccb83..5ecb9c5 100644 --- a/docs/types/StrOrRegExp.html +++ b/docs/types/StrOrRegExp.html @@ -20,7 +20,7 @@

    Type alias StrOrRegExp

    +
  • Defined in src/field-mappings.ts:8
    • diff --git a/docs/variables/fieldMappings.html b/docs/variables/fieldMappings.html index d3e9d09..d4bfa22 100644 --- a/docs/variables/fieldMappings.html +++ b/docs/variables/fieldMappings.html @@ -17,7 +17,7 @@

    Variable fieldMappingsConst

    fieldMappings: FieldMapping[] = ...
    +
  • Defined in src/field-mappings.ts:131
    • diff --git a/src/generator.ts b/src/generator.ts index ee2f2c3..6276cc2 100644 --- a/src/generator.ts +++ b/src/generator.ts @@ -142,6 +142,7 @@ export class Generator { .with("base table", () => "Table" as const) .with("table", () => "Table" as const) .with("view", () => "View" as const) + .with("materialized view", () => "View" as const) .otherwise(() => null); }