SQLQueryHelperjs - v1.2.6
Preparing search index...
index
MySqlReflector
Class MySqlReflector
Index
Constructors
constructor
Methods
connect
close
get
Client
inspect
Schema
generate
Entity
Classes
get
Schema
Change
History
clear
Schema
Change
History
plan
Reflect
reflect
select
select
From
Entity
Select
insert
Into
insert
Entity
Insert
Into
update
update
Entity
Update
delete
From
delete
Entity
Delete
From
query
execute
transaction
Async
register
Store
Procedure
register
Store
Procedures
get
Registered
Store
Procedures
clear
Registered
Store
Procedures
sync
Registered
Store
Procedures
create
Store
Procedure
create
Store
Procedures
call
Store
Procedure
drop
Store
Procedure
create
Trigger
drop
Trigger
create
View
drop
View
Constructors
constructor
new
MySqlReflector
(
config
:
MySqlConnection
|
MySqlReflectorConfig
,
_options
?:
MySqlReflectorOptions
,
)
:
MySqlReflector
Parameters
config
:
MySqlConnection
|
MySqlReflectorConfig
_options
:
MySqlReflectorOptions
= {}
Returns
MySqlReflector
Methods
connect
connect
()
:
Promise
<
void
>
Returns
Promise
<
void
>
close
close
()
:
Promise
<
void
>
Returns
Promise
<
void
>
get
Client
getClient
()
:
MySqlConnection
Returns
MySqlConnection
inspect
Schema
inspectSchema
(
options
?:
MySqlInspectorOptions
)
:
Promise
<
MySqlInspectedSchema
>
Parameters
options
:
MySqlInspectorOptions
= {}
Returns
Promise
<
MySqlInspectedSchema
>
generate
Entity
Classes
generateEntityClasses
(
options
?:
MySqlSchemaGenerationOptions
)
:
Promise
<
string
>
Parameters
options
:
MySqlSchemaGenerationOptions
= {}
Returns
Promise
<
string
>
get
Schema
Change
History
getSchemaChangeHistory
(
limit
?:
number
)
:
Promise
<
MySqlSchemaChangeHistoryEntry
[]
>
Parameters
limit
:
number
= 100
Returns
Promise
<
MySqlSchemaChangeHistoryEntry
[]
>
clear
Schema
Change
History
clearSchemaChangeHistory
()
:
Promise
<
number
>
Returns
Promise
<
number
>
plan
Reflect
planReflect
(
...
entities
:
EntityClass
[]
)
:
Promise
<
MySqlSchemaSyncPreview
>
Parameters
...
entities
:
EntityClass
[]
Returns
Promise
<
MySqlSchemaSyncPreview
>
reflect
reflect
(
...
entities
:
EntityClass
[]
)
:
Promise
<
void
>
Parameters
...
entities
:
EntityClass
[]
Returns
Promise
<
void
>
select
select
(
columns
?:
SelectColumns
)
:
MySqlQueryBuilder
Parameters
columns
:
SelectColumns
= "*"
Returns
MySqlQueryBuilder
select
From
Entity
selectFromEntity
<
TInstance
extends
object
>
(
entityClass
:
EntityClass
<
TInstance
>
,
columns
?:
"*"
|
Extract
<
keyof
TInstance
,
string
>
[]
,
alias
?:
string
,
)
:
MySqlQueryBuilder
Type Parameters
TInstance
extends
object
Parameters
entityClass
:
EntityClass
<
TInstance
>
columns
:
"*"
|
Extract
<
keyof
TInstance
,
string
>
[]
= "*"
Optional
alias
:
string
Returns
MySqlQueryBuilder
Select
Select
(
columns
?:
SelectColumns
)
:
MySqlQueryBuilder
Parameters
columns
:
SelectColumns
= "*"
Returns
MySqlQueryBuilder
insert
Into
insertInto
(
table
:
string
)
:
MySqlInsertBuilder
Parameters
table
:
string
Returns
MySqlInsertBuilder
insert
Entity
insertEntity
<
TInstance
extends
object
>
(
entityClass
:
EntityClass
<
TInstance
>
,
)
:
MySqlInsertBuilder
Type Parameters
TInstance
extends
object
Parameters
entityClass
:
EntityClass
<
TInstance
>
Returns
MySqlInsertBuilder
Insert
Into
InsertInto
(
table
:
string
)
:
MySqlInsertBuilder
Parameters
table
:
string
Returns
MySqlInsertBuilder
update
update
(
table
:
string
)
:
MySqlUpdateBuilder
Parameters
table
:
string
Returns
MySqlUpdateBuilder
update
Entity
updateEntity
<
TInstance
extends
object
>
(
entityClass
:
EntityClass
<
TInstance
>
,
)
:
MySqlUpdateBuilder
Type Parameters
TInstance
extends
object
Parameters
entityClass
:
EntityClass
<
TInstance
>
Returns
MySqlUpdateBuilder
Update
Update
(
table
:
string
)
:
MySqlUpdateBuilder
Parameters
table
:
string
Returns
MySqlUpdateBuilder
delete
From
deleteFrom
(
table
:
string
)
:
MySqlDeleteBuilder
Parameters
table
:
string
Returns
MySqlDeleteBuilder
delete
Entity
deleteEntity
<
TInstance
extends
object
>
(
entityClass
:
EntityClass
<
TInstance
>
,
)
:
MySqlDeleteBuilder
Type Parameters
TInstance
extends
object
Parameters
entityClass
:
EntityClass
<
TInstance
>
Returns
MySqlDeleteBuilder
Delete
From
DeleteFrom
(
table
:
string
)
:
MySqlDeleteBuilder
Parameters
table
:
string
Returns
MySqlDeleteBuilder
query
query
<
TRow
extends
Record
<
string
,
unknown
>
=
Record
<
string
,
unknown
>
>
(
sql
:
string
,
params
?:
unknown
[]
,
)
:
Promise
<
TRow
[]
>
Type Parameters
TRow
extends
Record
<
string
,
unknown
>
=
Record
<
string
,
unknown
>
Parameters
sql
:
string
params
:
unknown
[]
= []
Returns
Promise
<
TRow
[]
>
execute
execute
(
sql
:
string
,
params
?:
unknown
[]
)
:
Promise
<
{
rowCount
:
number
}
>
Parameters
sql
:
string
params
:
unknown
[]
= []
Returns
Promise
<
{
rowCount
:
number
}
>
transaction
Async
transactionAsync
<
T
>
(
handler
:
(
db
:
MySqlReflector
)
=>
T
|
Promise
<
T
>
,
options
?:
MySqlTransactionOptions
,
)
:
Promise
<
T
>
Type Parameters
T
Parameters
handler
:
(
db
:
MySqlReflector
)
=>
T
|
Promise
<
T
>
options
:
MySqlTransactionOptions
= {}
Returns
Promise
<
T
>
register
Store
Procedure
registerStoreProcedure
(
procedure
:
MySqlStoreProcedureInput
,
)
:
MySqlRegisteredStoreProcedure
Parameters
procedure
:
MySqlStoreProcedureInput
Returns
MySqlRegisteredStoreProcedure
register
Store
Procedures
registerStoreProcedures
(
...
procedures
:
MySqlStoreProcedureInput
[]
,
)
:
MySqlRegisteredStoreProcedure
[]
Parameters
...
procedures
:
MySqlStoreProcedureInput
[]
Returns
MySqlRegisteredStoreProcedure
[]
get
Registered
Store
Procedures
getRegisteredStoreProcedures
()
:
MySqlRegisteredStoreProcedure
[]
Returns
MySqlRegisteredStoreProcedure
[]
clear
Registered
Store
Procedures
clearRegisteredStoreProcedures
()
:
number
Returns
number
sync
Registered
Store
Procedures
syncRegisteredStoreProcedures
()
:
Promise
<
void
>
Returns
Promise
<
void
>
create
Store
Procedure
createStoreProcedure
(
procedure
:
MySqlStoreProcedureInput
)
:
Promise
<
void
>
Parameters
procedure
:
MySqlStoreProcedureInput
Returns
Promise
<
void
>
create
Store
Procedures
createStoreProcedures
(
...
procedures
:
MySqlStoreProcedureInput
[]
)
:
Promise
<
void
>
Parameters
...
procedures
:
MySqlStoreProcedureInput
[]
Returns
Promise
<
void
>
call
Store
Procedure
callStoreProcedure
<
TRow
extends
Record
<
string
,
unknown
>
=
Record
<
string
,
unknown
>
,
>
(
procedure
:
string
|
MySqlStoreProcedureInput
,
args
?:
unknown
[]
,
options
?:
MySqlCallStoreProcedureOptions
,
)
:
Promise
<
TRow
[]
>
Type Parameters
TRow
extends
Record
<
string
,
unknown
>
=
Record
<
string
,
unknown
>
Parameters
procedure
:
string
|
MySqlStoreProcedureInput
args
:
unknown
[]
= []
options
:
MySqlCallStoreProcedureOptions
= {}
Returns
Promise
<
TRow
[]
>
drop
Store
Procedure
dropStoreProcedure
(
procedure
:
string
|
MySqlStoreProcedureInput
,
options
?:
MySqlDropStoreProcedureOptions
,
)
:
Promise
<
number
>
Parameters
procedure
:
string
|
MySqlStoreProcedureInput
options
:
MySqlDropStoreProcedureOptions
= {}
Returns
Promise
<
number
>
create
Trigger
createTrigger
(
definition
:
MySqlTriggerDefinition
)
:
Promise
<
void
>
Parameters
definition
:
MySqlTriggerDefinition
Returns
Promise
<
void
>
drop
Trigger
dropTrigger
(
name
:
string
,
table
?:
string
,
options
?:
MySqlDropTriggerOptions
,
)
:
Promise
<
number
>
Parameters
name
:
string
Optional
table
:
string
options
:
MySqlDropTriggerOptions
= {}
Returns
Promise
<
number
>
create
View
createView
(
definition
:
MySqlViewDefinition
)
:
Promise
<
void
>
Parameters
definition
:
MySqlViewDefinition
Returns
Promise
<
void
>
drop
View
dropView
(
name
:
string
,
options
?:
MySqlDropViewOptions
)
:
Promise
<
number
>
Parameters
name
:
string
options
:
MySqlDropViewOptions
= {}
Returns
Promise
<
number
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
connect
close
get
Client
inspect
Schema
generate
Entity
Classes
get
Schema
Change
History
clear
Schema
Change
History
plan
Reflect
reflect
select
select
From
Entity
Select
insert
Into
insert
Entity
Insert
Into
update
update
Entity
Update
delete
From
delete
Entity
Delete
From
query
execute
transaction
Async
register
Store
Procedure
register
Store
Procedures
get
Registered
Store
Procedures
clear
Registered
Store
Procedures
sync
Registered
Store
Procedures
create
Store
Procedure
create
Store
Procedures
call
Store
Procedure
drop
Store
Procedure
create
Trigger
drop
Trigger
create
View
drop
View
SQLQueryHelperjs - v1.2.6
Loading...