Libraries v5.0.0
← Back to Website
All Versions
Preparing search index...
@cleverbrush/knex-schema
extension
object
Variable object
Const
object
:
ExtendedObjectFactory
<
{
hasColumnName
(
this
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
,
name
:
string
,
)
:
SchemaBuilder
<
any
,
any
,
any
,
false
,
{}
>
;
hasTableName
(
this
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
,
name
:
string
,
)
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
;
}
&
{
afterInsert
(
this
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
,
fn
:
Function
,
)
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
;
beforeDelete
(
this
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
,
fn
:
Function
,
)
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
;
beforeInsert
(
this
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
,
fn
:
Function
,
)
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
;
beforeUpdate
(
this
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
,
fn
:
Function
,
)
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
;
belongsTo
(
this
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
,
name
:
string
,
opts
:
{
foreignKey
:
any
;
schema
:
any
}
,
)
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
;
belongsToMany
(
this
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
,
name
:
string
,
opts
:
{
schema
:
any
;
through
:
{
foreignKey
:
string
;
localKey
:
string
;
table
:
string
}
;
}
,
)
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
;
columnType
(
this
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
,
type
:
string
,
)
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
;
defaultScope
<
S
extends
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
,
>
(
this
:
S
,
fn
:
(
query
:
QueryScope
<
S
>
)
=>
QueryScope
<
S
>
,
)
:
S
;
hasCheck
(
this
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
,
sql
:
string
,
)
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
;
hasIndex
(
this
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
,
columns
:
string
[]
,
opts
?:
{
name
?:
string
;
unique
?:
boolean
}
,
)
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
;
hasMany
(
this
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
,
name
:
string
,
opts
:
{
foreignKey
:
any
;
schema
:
any
}
,
)
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
;
hasOne
(
this
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
,
name
:
string
,
opts
:
{
foreignKey
:
any
;
schema
:
any
}
,
)
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
;
hasRawColumn
(
this
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
,
name
:
string
,
definition
:
string
,
)
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
;
hasRawIndex
(
this
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
,
sql
:
string
,
)
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
;
hasTimestamps
(
this
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
,
opts
?:
{
createdAt
?:
string
;
updatedAt
?:
string
}
,
)
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
;
hasUnique
(
this
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
,
columns
:
string
[]
,
name
?:
string
,
)
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
;
json
(
this
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
,
)
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
;
jsonb
(
this
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
,
)
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
;
projection
<
TProperties
extends
Record
<
string
,
SchemaBuilder
<
any
,
any
,
any
,
any
,
any
>
>
,
const
N
extends
string
,
const
TKey
extends
string
,
>
(
this
:
ObjectSchemaBuilder
<
TProperties
,
any
,
any
,
any
,
any
,
any
,
any
>
,
name
:
N
,
...
columns
:
readonly
(
|
TKey
|
(
(
t
:
PropertyDescriptorTree
<
ObjectSchemaBuilder
<
TProperties
,
any
,
any
,
any
,
any
,
any
,
any
>
,
ObjectSchemaBuilder
<
TProperties
,
any
,
any
,
any
,
any
,
any
,
any
>
,
>
,
)
=>
PropertyDescriptor
<
any
,
any
,
any
,
TKey
>
)
)
[]
,
)
:
ObjectSchemaBuilder
<
TProperties
,
any
,
any
,
any
,
any
,
any
,
any
>
&
{
__cleverbrush_extra_type_brand__
?:
{
[
P
in
string
]
:
readonly
TKey
[]
}
;
}
;
scope
<
N
extends
string
,
S
extends
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
,
>
(
this
:
S
,
name
:
N
,
fn
:
(
query
:
QueryScope
<
S
>
)
=>
QueryScope
<
S
>
,
)
:
S
&
{
__cleverbrush_method_literal_brand__
?:
N
}
;
softDelete
(
this
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
,
opts
?:
{
column
?:
string
}
,
)
:
ObjectSchemaBuilder
<
any
,
any
,
any
,
any
,
any
,
any
,
any
>
;
}
,
>
= extended.object
Create an object schema with table, relation, scope, projection and lifecycle extensions.
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
← Back to Website
All Versions
Libraries v5.0.0
Loading...
Create an object schema with table, relation, scope, projection and lifecycle extensions.