IAdminForthDataSourceConnectorBase
Interface that exposes methods to interact with AdminForth in standard way
Extends
Properties
client
client:
any
Inherited from
IAdminForthDataSourceConnector
. client
Methods
createRecord()
createRecord(
__namedParameters
):Promise
<object
>
Parameters
Parameter | Type |
---|---|
__namedParameters | object |
__namedParameters.adminUser | AdminUser |
__namedParameters.record | any |
__namedParameters.resource | AdminForthResource |
Returns
Promise
<object
>
createdRecord?
optional
createdRecord:any
error?
optional
error:string
ok
ok:
boolean
createRecordOriginalValues()
createRecordOriginalValues(
__namedParameters
):Promise
<string
>
Used to create record in database. Should return value of primary key column of created record.
Parameters
Parameter | Type |
---|---|
__namedParameters | object |
__namedParameters.record | any |
__namedParameters.resource | AdminForthResource |
Returns
Promise
<string
>
Inherited from
IAdminForthDataSourceConnector
. createRecordOriginalValues
deleteRecord()
deleteRecord(
__namedParameters
):Promise
<boolean
>
Used to delete record in database.
Parameters
Parameter | Type |
---|---|
__namedParameters | object |
__namedParameters.recordId | any |
__namedParameters.resource | AdminForthResource |
Returns
Promise
<boolean
>
Inherited from
IAdminForthDataSourceConnector
. deleteRecord
discoverFields()
discoverFields(
resource
):Promise
<object
>
Function should go over all columns of table defined in resource.table and try to guess data and constraints for each columns. Type should be saved to:
- AdminForthResourceColumn.type Constraints:
- AdminForthResourceColumn.required
- AdminForthResourceColumn.primaryKey For string fields:
- AdminForthResourceColumn.maxLength For numbers:
- AdminForthResourceColumn.min
- AdminForthResourceColumn.max
- AdminForthResourceColumn.minValue, AdminForthResourceColumn.maxValue, AdminForthResourceColumn.enum, AdminForthResourceColumn.foreignResource, AdminForthResourceColumn.sortable, AdminForthResourceColumn.backendOnly, AdminForthResourceColumn.masked, AdminForthResourceColumn.virtual, AdminForthResourceColumn.components, AdminForthResourceColumn.allowMinMaxQuery, AdminForthResourceColumn.editingNote, AdminForthResourceColumn.showIn, AdminForthResourceColumn.isUnique, AdminForthResourceColumn.validation) Also you can additionally save original column type to AdminForthResourceColumn._underlineType. This might be later used in IAdminForthDataSourceConnector.getFieldValue and IAdminForthDataSourceConnector.setFieldValue methods.
Parameters
Parameter | Type | Description |
---|---|---|
resource | AdminForthResource |
Returns
Promise
<object
>
Inherited from
IAdminForthDataSourceConnector
. discoverFields
getAllColumnsInTable()
getAllColumnsInTable(
tableName
):Promise
<object
[]>
Function to get all columns in table.
Parameters
Parameter | Type |
---|---|
tableName | string |
Returns
Promise
<object
[]>
Inherited from
IAdminForthDataSourceConnector
. getAllColumnsInTable
getAllTables()
getAllTables():
Promise
<string
[]>
Function to get all tables from database.
Returns
Promise
<string
[]>
Inherited from
IAdminForthDataSourceConnector
. getAllTables
getCount()
getCount(
__namedParameters
):Promise
<number
>
Used to get count of records in database.
Parameters
Parameter | Type |
---|---|
__namedParameters | object |
__namedParameters.filters | IAdminForthAndOrFilter |
__namedParameters.resource | AdminForthResource |
Returns
Promise
<number
>
Inherited from
IAdminForthDataSourceConnector
. getCount
getData()
getData(
__namedParameters
):Promise
<object
>
Parameters
Parameter | Type |
---|---|
__namedParameters | object |
__namedParameters.filters | IAdminForthAndOrFilter |
__namedParameters.getTotals ? | boolean |
__namedParameters.limit | number |
__namedParameters.offset | number |
__namedParameters.resource | AdminForthResource |
__namedParameters.sort | IAdminForthSort [] |
Returns
Promise
<object
>
data
data:
any
[]
total
total:
number
getDataWithOriginalTypes()
getDataWithOriginalTypes(
__namedParameters
):Promise
<any
[]>
Used to fetch data from database. This method is reused both to list records and show one record (by passing limit 1 and offset 0) .
Fields are returned from db "as is" then AdminForthBaseConnector.getData will transform each field using IAdminForthDataSourceConnector.getFieldValue
Parameters
Parameter | Type |
---|---|
__namedParameters | object |
__namedParameters.filters | IAdminForthAndOrFilter |
__namedParameters.limit | number |
__namedParameters.offset | number |
__namedParameters.resource | AdminForthResource |
__namedParameters.sort | IAdminForthSort [] |
Returns
Promise
<any
[]>
Inherited from
IAdminForthDataSourceConnector
. getDataWithOriginalTypes
getFieldValue()
getFieldValue(
field
,value
):any
Used to transform record after fetching from database. According to AdminForth convention, if AdminForthResourceColumn.type is set to AdminForthDataTypes.DATETIME then it should be transformed to ISO string.
Parameters
Parameter | Type | Description |
---|---|---|
field | AdminForthResourceColumn | |
value | any |
Returns
any
Inherited from
IAdminForthDataSourceConnector
. getFieldValue