DataSyncMongoDBDataProvider
Mongo provider that attains data synchronization using soft deletes
#
Type parameters▪ Type
#
HierarchyMongoDBDataProvider‹Type›
↳ DataSyncMongoDBDataProvider
#
Implements- GraphbackDataProvider‹Type›
- DataSyncProvider
#
Index#
Constructors#
Properties#
Methods#
Constructors#
constructor+ new DataSyncMongoDBDataProvider(model
: ModelDefinition, client
: any): DataSyncMongoDBDataProvider
Overrides void
Defined in packages/graphback-datasync/src/providers/DatasyncMongoDBDataProvider.ts:11
Parameters:
Name | Type |
---|---|
model | ModelDefinition |
client | any |
Returns: DataSyncMongoDBDataProvider
#
PropertiesProtected
TTLinSeconds#
• TTLinSeconds: number
Defined in packages/graphback-datasync/src/providers/DatasyncMongoDBDataProvider.ts:11
Protected
coerceTSFields#
• coerceTSFields: boolean
Inherited from DataSyncMongoDBDataProvider.coerceTSFields
Defined in packages/graphback-runtime-mongodb/types/MongoDBDataProvider.d.ts:11
Protected
collectionName#
• collectionName: string
Inherited from DataSyncMongoDBDataProvider.collectionName
Defined in packages/graphback-runtime-mongodb/types/MongoDBDataProvider.d.ts:8
Protected
db#
• db: Db
Inherited from DataSyncMongoDBDataProvider.db
Defined in packages/graphback-runtime-mongodb/types/MongoDBDataProvider.d.ts:7
Protected
fieldTransformMap#
• fieldTransformMap: FieldTransformMap
Inherited from DataSyncMongoDBDataProvider.fieldTransformMap
Defined in packages/graphback-runtime-mongodb/types/MongoDBDataProvider.d.ts:10
Protected
tableMap#
• tableMap: ModelTableMap
Inherited from DataSyncMongoDBDataProvider.tableMap
Defined in packages/graphback-runtime-mongodb/types/MongoDBDataProvider.d.ts:9
#
Methods#
batchRead▸ batchRead(relationField
: string, ids
: string[], filter?
: QueryFilter, selectedFields?
: string[]): Promise‹Type[][]›
Implementation of DataSyncProvider
Inherited from DataSyncMongoDBDataProvider.batchRead
Defined in packages/graphback-runtime-mongodb/types/MongoDBDataProvider.d.ts:19
Parameters:
Name | Type |
---|---|
relationField | string |
ids | string[] |
filter? | QueryFilter |
selectedFields? | string[] |
Returns: Promise‹Type[][]›
Protected
buildProjectionOption#
▸ buildProjectionOption(selectedFields
: string[]): object
Inherited from DataSyncMongoDBDataProvider.buildProjectionOption
Defined in packages/graphback-runtime-mongodb/types/MongoDBDataProvider.d.ts:20
Parameters:
Name | Type |
---|---|
selectedFields | string[] |
Returns: object
- [ x: string]: any
#
count▸ count(filter
: QueryFilter): Promise‹number›
Implementation of DataSyncProvider
Overrides void
Defined in packages/graphback-datasync/src/providers/DatasyncMongoDBDataProvider.ts:121
Parameters:
Name | Type |
---|---|
filter | QueryFilter |
Returns: Promise‹number›
#
create▸ create(data
: any): Promise‹Type›
Overrides void
Defined in packages/graphback-datasync/src/providers/DatasyncMongoDBDataProvider.ts:39
Parameters:
Name | Type |
---|---|
data | any |
Returns: Promise‹Type›
#
delete▸ delete(data
: any, selectedFields?
: string[]): Promise‹Type›
Overrides void
Defined in packages/graphback-datasync/src/providers/DatasyncMongoDBDataProvider.ts:68
Parameters:
Name | Type |
---|---|
data | any |
selectedFields? | string[] |
Returns: Promise‹Type›
#
findBy▸ findBy(args?
: FindByArgs, selectedFields?
: string[]): Promise‹Type[]›
Implementation of DataSyncProvider
Overrides void
Defined in packages/graphback-datasync/src/providers/DatasyncMongoDBDataProvider.ts:107
Parameters:
Name | Type |
---|---|
args? | FindByArgs |
selectedFields? | string[] |
Returns: Promise‹Type[]›
#
findOne▸ findOne(filter
: any, selectedFields?
: string[]): Promise‹Type›
Overrides void
Defined in packages/graphback-datasync/src/providers/DatasyncMongoDBDataProvider.ts:90
Parameters:
Name | Type |
---|---|
filter | any |
selectedFields? | string[] |
Returns: Promise‹Type›
#
sync▸ sync(lastSync
: Date, selectedFields?
: string[], filter?
: QueryFilter, limit?
: number): Promise‹Type[]›
Implementation of DataSyncProvider
Defined in packages/graphback-datasync/src/providers/DatasyncMongoDBDataProvider.ts:129
Parameters:
Name | Type |
---|---|
lastSync | Date |
selectedFields? | string[] |
filter? | QueryFilter |
limit? | number |
Returns: Promise‹Type[]›
#
update▸ update(data
: any, selectedFields?
: string[]): Promise‹Type›
Overrides void
Defined in packages/graphback-datasync/src/providers/DatasyncMongoDBDataProvider.ts:46
Parameters:
Name | Type |
---|---|
data | any |
selectedFields? | string[] |
Returns: Promise‹Type›