Esposter
Preparing search index...
@esposter/db-schema
PgTable
Interface PgTable
PgTable
<
TTableName
extends
string
,
TColumnsMap
extends
Record
<
string
,
AnyPgColumnBuilder
>
,
TSchema
extends
string
,
>
(
name
:
TTableName
,
columns
:
TColumnsMap
,
config
?:
{
extraConfig
?:
(
self
:
{
[
Key
in
string
|
number
|
symbol
]
:
ExtraConfigColumn
<
PgColumnBaseConfig
<
ColumnType
>
,
>
}
,
)
=>
PgTableExtraConfigValue
[]
;
schema
?:
PgSchema
<
TSchema
>
;
}
,
)
:
PgTableWithColumns
<
{
columns
:
{
[
Key
in
string
|
number
|
symbol
]
:
PgBuildColumn
<
TTableName
,
(
TColumnsMap
&
{
createdAt
:
SetHasDefault
<
SetNotNull
<
PgTimestampBuilder
>
>
;
deletedAt
:
PgTimestampBuilder
;
updatedAt
:
SetHasDefault
<
SetNotNull
<
PgTimestampBuilder
>
>
;
}
)
[
Key
]
,
{
data
:
(
TColumnsMap
&
{
createdAt
:
...
;
deletedAt
:
...
;
updatedAt
:
...
}
)
[
Key
]
[
"_"
]
[
"dimensions"
]
extends
1
|
2
|
3
|
4
|
5
?
WrapArray
<
GetBaseData
<
((...)
&
(...))
[
Key
]
[
"_"
]
>
,
any
[
any
]
>
:
GetBaseData
<
(
TColumnsMap
&
{
createdAt
:
...
;
deletedAt
:
...
;
updatedAt
:
...
}
)
[
Key
]
[
"_"
]
,
>
;
dataType
:
(
TColumnsMap
&
{
createdAt
:
SetHasDefault
<
(...)
>
;
deletedAt
:
PgTimestampBuilder
;
updatedAt
:
SetHasDefault
<
(...)
>
;
}
)
[
Key
]
[
"_"
]
[
"dataType"
]
;
driverParam
:
(
TColumnsMap
&
{
createdAt
:
...
;
deletedAt
:
...
;
updatedAt
:
...
}
)
[
Key
]
[
"_"
]
[
"dimensions"
]
extends
1
|
2
|
3
|
4
|
5
?
string
|
WrapArray
<
(...)
[
(...)
]
[
"_"
]
[
"driverParam"
]
,
any
[
any
]
>
:
(
TColumnsMap
&
{
createdAt
:
...
;
deletedAt
:
...
;
updatedAt
:
...
}
)
[
Key
]
[
"_"
]
[
"driverParam"
]
;
enumValues
:
(
TColumnsMap
&
{
createdAt
:
SetHasDefault
<
(...)
>
;
deletedAt
:
PgTimestampBuilder
;
updatedAt
:
SetHasDefault
<
(...)
>
;
}
)
[
Key
]
[
"_"
]
extends
{
enumValues
:
E
}
?
E
:
undefined
;
generated
:
(
TColumnsMap
&
{
createdAt
:
...
;
deletedAt
:
...
;
updatedAt
:
...
}
)
[
Key
]
[
"_"
]
[
"generated"
]
extends
true
?
true
:
undefined
;
hasDefault
:
(
TColumnsMap
&
{
createdAt
:
...
;
deletedAt
:
...
;
updatedAt
:
...
}
)
[
Key
]
[
"_"
]
[
"hasDefault"
]
extends
true
?
true
:
false
;
hasRuntimeDefault
:
false
;
identity
:
(
TColumnsMap
&
{
createdAt
:
...
;
deletedAt
:
...
;
updatedAt
:
...
}
)
[
Key
]
[
"_"
]
[
"identity"
]
extends
"always"
|
"byDefault"
?
any
[
any
]
:
undefined
;
isAutoincrement
:
false
;
isPrimaryKey
:
false
;
name
:
string
;
notNull
:
(
TColumnsMap
&
{
createdAt
:
...
;
deletedAt
:
...
;
updatedAt
:
...
}
)
[
Key
]
[
"_"
]
[
"notNull"
]
extends
true
?
true
:
false
;
tableName
:
TTableName
;
}
,
>
}
;
dialect
:
"pg"
;
name
:
TTableName
;
schema
:
TSchema
;
}
,
>
Type Parameters
TTableName
extends
string
TColumnsMap
extends
Record
<
string
,
AnyPgColumnBuilder
>
TSchema
extends
string
Parameters
name
:
TTableName
columns
:
TColumnsMap
Optional
config
:
{
extraConfig
?:
(
self
:
{
[
Key
in
string
|
number
|
symbol
]
:
ExtraConfigColumn
<
PgColumnBaseConfig
<
ColumnType
>
,
>
}
,
)
=>
PgTableExtraConfigValue
[]
;
schema
?:
PgSchema
<
TSchema
>
;
}
Returns
PgTableWithColumns
<
{
columns
:
{
[
Key
in
string
|
number
|
symbol
]
:
PgBuildColumn
<
TTableName
,
(
TColumnsMap
&
{
createdAt
:
SetHasDefault
<
SetNotNull
<
PgTimestampBuilder
>
>
;
deletedAt
:
PgTimestampBuilder
;
updatedAt
:
SetHasDefault
<
SetNotNull
<
PgTimestampBuilder
>
>
;
}
)
[
Key
]
,
{
data
:
(
TColumnsMap
&
{
createdAt
:
...
;
deletedAt
:
...
;
updatedAt
:
...
}
)
[
Key
]
[
"_"
]
[
"dimensions"
]
extends
1
|
2
|
3
|
4
|
5
?
WrapArray
<
GetBaseData
<
((...)
&
(...))
[
Key
]
[
"_"
]
>
,
any
[
any
]
>
:
GetBaseData
<
(
TColumnsMap
&
{
createdAt
:
...
;
deletedAt
:
...
;
updatedAt
:
...
}
)
[
Key
]
[
"_"
]
,
>
;
dataType
:
(
TColumnsMap
&
{
createdAt
:
SetHasDefault
<
(...)
>
;
deletedAt
:
PgTimestampBuilder
;
updatedAt
:
SetHasDefault
<
(...)
>
;
}
)
[
Key
]
[
"_"
]
[
"dataType"
]
;
driverParam
:
(
TColumnsMap
&
{
createdAt
:
...
;
deletedAt
:
...
;
updatedAt
:
...
}
)
[
Key
]
[
"_"
]
[
"dimensions"
]
extends
1
|
2
|
3
|
4
|
5
?
string
|
WrapArray
<
(...)
[
(...)
]
[
"_"
]
[
"driverParam"
]
,
any
[
any
]
>
:
(
TColumnsMap
&
{
createdAt
:
...
;
deletedAt
:
...
;
updatedAt
:
...
}
)
[
Key
]
[
"_"
]
[
"driverParam"
]
;
enumValues
:
(
TColumnsMap
&
{
createdAt
:
SetHasDefault
<
(...)
>
;
deletedAt
:
PgTimestampBuilder
;
updatedAt
:
SetHasDefault
<
(...)
>
;
}
)
[
Key
]
[
"_"
]
extends
{
enumValues
:
E
}
?
E
:
undefined
;
generated
:
(
TColumnsMap
&
{
createdAt
:
...
;
deletedAt
:
...
;
updatedAt
:
...
}
)
[
Key
]
[
"_"
]
[
"generated"
]
extends
true
?
true
:
undefined
;
hasDefault
:
(
TColumnsMap
&
{
createdAt
:
...
;
deletedAt
:
...
;
updatedAt
:
...
}
)
[
Key
]
[
"_"
]
[
"hasDefault"
]
extends
true
?
true
:
false
;
hasRuntimeDefault
:
false
;
identity
:
(
TColumnsMap
&
{
createdAt
:
...
;
deletedAt
:
...
;
updatedAt
:
...
}
)
[
Key
]
[
"_"
]
[
"identity"
]
extends
"always"
|
"byDefault"
?
any
[
any
]
:
undefined
;
isAutoincrement
:
false
;
isPrimaryKey
:
false
;
name
:
string
;
notNull
:
(
TColumnsMap
&
{
createdAt
:
...
;
deletedAt
:
...
;
updatedAt
:
...
}
)
[
Key
]
[
"_"
]
[
"notNull"
]
extends
true
?
true
:
false
;
tableName
:
TTableName
;
}
,
>
}
;
dialect
:
"pg"
;
name
:
TTableName
;
schema
:
TSchema
;
}
,
>
PgTable
<
TTableName
extends
string
,
TColumnsMap
extends
Record
<
string
,
AnyPgColumnBuilder
>
,
>
(
name
:
TTableName
,
columns
:
TColumnsMap
,
config
?:
{
extraConfig
?:
(
self
:
{
[
Key
in
string
|
number
|
symbol
]
:
ExtraConfigColumn
<
PgColumnBaseConfig
<
ColumnType
>
,
>
}
,
)
=>
PgTableExtraConfigValue
[]
;
}
,
)
:
PgTableWithColumns
<
{
columns
:
{
[
Key
in
string
|
number
|
symbol
]
:
PgBuildColumn
<
TTableName
,
(
TColumnsMap
&
{
createdAt
:
SetHasDefault
<
SetNotNull
<
PgTimestampBuilder
>
>
;
deletedAt
:
PgTimestampBuilder
;
updatedAt
:
SetHasDefault
<
SetNotNull
<
PgTimestampBuilder
>
>
;
}
)
[
Key
]
,
{
data
:
(
TColumnsMap
&
{
createdAt
:
...
;
deletedAt
:
...
;
updatedAt
:
...
}
)
[
Key
]
[
"_"
]
[
"dimensions"
]
extends
1
|
2
|
3
|
4
|
5
?
WrapArray
<
GetBaseData
<
((...)
&
(...))
[
Key
]
[
"_"
]
>
,
any
[
any
]
>
:
GetBaseData
<
(
TColumnsMap
&
{
createdAt
:
...
;
deletedAt
:
...
;
updatedAt
:
...
}
)
[
Key
]
[
"_"
]
,
>
;
dataType
:
(
TColumnsMap
&
{
createdAt
:
SetHasDefault
<
(...)
>
;
deletedAt
:
PgTimestampBuilder
;
updatedAt
:
SetHasDefault
<
(...)
>
;
}
)
[
Key
]
[
"_"
]
[
"dataType"
]
;
driverParam
:
(
TColumnsMap
&
{
createdAt
:
...
;
deletedAt
:
...
;
updatedAt
:
...
}
)
[
Key
]
[
"_"
]
[
"dimensions"
]
extends
1
|
2
|
3
|
4
|
5
?
string
|
WrapArray
<
(...)
[
(...)
]
[
"_"
]
[
"driverParam"
]
,
any
[
any
]
>
:
(
TColumnsMap
&
{
createdAt
:
...
;
deletedAt
:
...
;
updatedAt
:
...
}
)
[
Key
]
[
"_"
]
[
"driverParam"
]
;
enumValues
:
(
TColumnsMap
&
{
createdAt
:
SetHasDefault
<
(...)
>
;
deletedAt
:
PgTimestampBuilder
;
updatedAt
:
SetHasDefault
<
(...)
>
;
}
)
[
Key
]
[
"_"
]
extends
{
enumValues
:
E
}
?
E
:
undefined
;
generated
:
(
TColumnsMap
&
{
createdAt
:
...
;
deletedAt
:
...
;
updatedAt
:
...
}
)
[
Key
]
[
"_"
]
[
"generated"
]
extends
true
?
true
:
undefined
;
hasDefault
:
(
TColumnsMap
&
{
createdAt
:
...
;
deletedAt
:
...
;
updatedAt
:
...
}
)
[
Key
]
[
"_"
]
[
"hasDefault"
]
extends
true
?
true
:
false
;
hasRuntimeDefault
:
false
;
identity
:
(
TColumnsMap
&
{
createdAt
:
...
;
deletedAt
:
...
;
updatedAt
:
...
}
)
[
Key
]
[
"_"
]
[
"identity"
]
extends
"always"
|
"byDefault"
?
any
[
any
]
:
undefined
;
isAutoincrement
:
false
;
isPrimaryKey
:
false
;
name
:
string
;
notNull
:
(
TColumnsMap
&
{
createdAt
:
...
;
deletedAt
:
...
;
updatedAt
:
...
}
)
[
Key
]
[
"_"
]
[
"notNull"
]
extends
true
?
true
:
false
;
tableName
:
TTableName
;
}
,
>
}
;
dialect
:
"pg"
;
name
:
TTableName
;
schema
:
undefined
;
}
,
>
Type Parameters
TTableName
extends
string
TColumnsMap
extends
Record
<
string
,
AnyPgColumnBuilder
>
Parameters
name
:
TTableName
columns
:
TColumnsMap
Optional
config
:
{
extraConfig
?:
(
self
:
{
[
Key
in
string
|
number
|
symbol
]
:
ExtraConfigColumn
<
PgColumnBaseConfig
<
ColumnType
>
,
>
}
,
)
=>
PgTableExtraConfigValue
[]
;
}
Returns
PgTableWithColumns
<
{
columns
:
{
[
Key
in
string
|
number
|
symbol
]
:
PgBuildColumn
<
TTableName
,
(
TColumnsMap
&
{
createdAt
:
SetHasDefault
<
SetNotNull
<
PgTimestampBuilder
>
>
;
deletedAt
:
PgTimestampBuilder
;
updatedAt
:
SetHasDefault
<
SetNotNull
<
PgTimestampBuilder
>
>
;
}
)
[
Key
]
,
{
data
:
(
TColumnsMap
&
{
createdAt
:
...
;
deletedAt
:
...
;
updatedAt
:
...
}
)
[
Key
]
[
"_"
]
[
"dimensions"
]
extends
1
|
2
|
3
|
4
|
5
?
WrapArray
<
GetBaseData
<
((...)
&
(...))
[
Key
]
[
"_"
]
>
,
any
[
any
]
>
:
GetBaseData
<
(
TColumnsMap
&
{
createdAt
:
...
;
deletedAt
:
...
;
updatedAt
:
...
}
)
[
Key
]
[
"_"
]
,
>
;
dataType
:
(
TColumnsMap
&
{
createdAt
:
SetHasDefault
<
(...)
>
;
deletedAt
:
PgTimestampBuilder
;
updatedAt
:
SetHasDefault
<
(...)
>
;
}
)
[
Key
]
[
"_"
]
[
"dataType"
]
;
driverParam
:
(
TColumnsMap
&
{
createdAt
:
...
;
deletedAt
:
...
;
updatedAt
:
...
}
)
[
Key
]
[
"_"
]
[
"dimensions"
]
extends
1
|
2
|
3
|
4
|
5
?
string
|
WrapArray
<
(...)
[
(...)
]
[
"_"
]
[
"driverParam"
]
,
any
[
any
]
>
:
(
TColumnsMap
&
{
createdAt
:
...
;
deletedAt
:
...
;
updatedAt
:
...
}
)
[
Key
]
[
"_"
]
[
"driverParam"
]
;
enumValues
:
(
TColumnsMap
&
{
createdAt
:
SetHasDefault
<
(...)
>
;
deletedAt
:
PgTimestampBuilder
;
updatedAt
:
SetHasDefault
<
(...)
>
;
}
)
[
Key
]
[
"_"
]
extends
{
enumValues
:
E
}
?
E
:
undefined
;
generated
:
(
TColumnsMap
&
{
createdAt
:
...
;
deletedAt
:
...
;
updatedAt
:
...
}
)
[
Key
]
[
"_"
]
[
"generated"
]
extends
true
?
true
:
undefined
;
hasDefault
:
(
TColumnsMap
&
{
createdAt
:
...
;
deletedAt
:
...
;
updatedAt
:
...
}
)
[
Key
]
[
"_"
]
[
"hasDefault"
]
extends
true
?
true
:
false
;
hasRuntimeDefault
:
false
;
identity
:
(
TColumnsMap
&
{
createdAt
:
...
;
deletedAt
:
...
;
updatedAt
:
...
}
)
[
Key
]
[
"_"
]
[
"identity"
]
extends
"always"
|
"byDefault"
?
any
[
any
]
:
undefined
;
isAutoincrement
:
false
;
isPrimaryKey
:
false
;
name
:
string
;
notNull
:
(
TColumnsMap
&
{
createdAt
:
...
;
deletedAt
:
...
;
updatedAt
:
...
}
)
[
Key
]
[
"_"
]
[
"notNull"
]
extends
true
?
true
:
false
;
tableName
:
TTableName
;
}
,
>
}
;
dialect
:
"pg"
;
name
:
TTableName
;
schema
:
undefined
;
}
,
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Esposter
Loading...