DataSyncMongoDBDataProvider
Mongo provider that attains data synchronization using soft deletes
Type parameters#
▪ Type
Hierarchy#
MongoDBDataProvider‹Type›
↳ DataSyncMongoDBDataProvider
Implements#
- GraphbackDataProvider‹Type›
- DataSyncProvider
Index#
Constructors#
Properties#
Methods#
Constructors#
constructor#
+ new DataSyncMongoDBDataProvider(baseType: GraphQLObjectType, client: any): DataSyncMongoDBDataProvider
Overrides void
Defined in packages/graphback-datasync/src/providers/DatasyncMongoDBDataProvider.ts:11
Parameters:
| Name | Type |
|---|---|
baseType | GraphQLObjectType |
client | any |
Returns: DataSyncMongoDBDataProvider
Properties#
Protected coerceTSFields#
• coerceTSFields: boolean
Inherited from DataSyncMongoDBDataProvider.coerceTSFields
Defined in packages/graphback-runtime-mongodb/types/MongoDBDataProvider.d.ts:12
Protected collectionName#
• collectionName: string
Inherited from DataSyncMongoDBDataProvider.collectionName
Defined in packages/graphback-runtime-mongodb/types/MongoDBDataProvider.d.ts:9
Protected db#
• db: Db
Inherited from DataSyncMongoDBDataProvider.db
Defined in packages/graphback-runtime-mongodb/types/MongoDBDataProvider.d.ts:8
Protected fieldTransformMap#
• fieldTransformMap: FieldTransformMap
Inherited from DataSyncMongoDBDataProvider.fieldTransformMap
Defined in packages/graphback-runtime-mongodb/types/MongoDBDataProvider.d.ts:11
Protected tableMap#
• tableMap: ModelTableMap
Inherited from DataSyncMongoDBDataProvider.tableMap
Defined in packages/graphback-runtime-mongodb/types/MongoDBDataProvider.d.ts:10
Methods#
batchRead#
▸ batchRead(relationField: string, ids: string[], filter: any, context: GraphbackContext): Promise‹Type[][]›
Inherited from DataSyncMongoDBDataProvider.batchRead
Defined in packages/graphback-runtime-mongodb/types/MongoDBDataProvider.d.ts:20
Parameters:
| Name | Type |
|---|---|
relationField | string |
ids | string[] |
filter | any |
context | GraphbackContext |
Returns: Promise‹Type[][]›
Protected buildProjectionOption#
▸ buildProjectionOption(context: GraphbackContext): object
Inherited from DataSyncMongoDBDataProvider.buildProjectionOption
Defined in packages/graphback-runtime-mongodb/types/MongoDBDataProvider.d.ts:22
Parameters:
| Name | Type |
|---|---|
context | GraphbackContext |
Returns: object
- [ x: string]: any
Protected checkForConflicts#
▸ checkForConflicts(clientData: any, context: GraphbackContext): Promise‹ConflictStateMap›
Defined in packages/graphback-datasync/src/providers/DatasyncMongoDBDataProvider.ts:116
Parameters:
| Name | Type |
|---|---|
clientData | any |
context | GraphbackContext |
Returns: Promise‹ConflictStateMap›
count#
▸ count(filter: any): Promise‹number›
Implementation of DataSyncProvider
Overrides void
Defined in packages/graphback-datasync/src/providers/DatasyncMongoDBDataProvider.ts:96
Parameters:
| Name | Type |
|---|---|
filter | any |
Returns: Promise‹number›
create#
▸ create(data: any, context: GraphbackContext): Promise‹Type›
Overrides void
Defined in packages/graphback-datasync/src/providers/DatasyncMongoDBDataProvider.ts:27
Parameters:
| Name | Type |
|---|---|
data | any |
context | GraphbackContext |
Returns: Promise‹Type›
delete#
▸ delete(data: any, context: GraphbackContext): Promise‹Type›
Overrides void
Defined in packages/graphback-datasync/src/providers/DatasyncMongoDBDataProvider.ts:44
Parameters:
| Name | Type |
|---|---|
data | any |
context | GraphbackContext |
Returns: Promise‹Type›
findBy#
▸ findBy(filter: QueryFilter‹Type› | any, context: GraphbackContext, page?: GraphbackPage, orderBy?: GraphbackOrderBy): Promise‹Type[]›
Overrides void
Defined in packages/graphback-datasync/src/providers/DatasyncMongoDBDataProvider.ts:86
Parameters:
| Name | Type |
|---|---|
filter | QueryFilter‹Type› | any |
context | GraphbackContext |
page? | GraphbackPage |
orderBy? | GraphbackOrderBy |
Returns: Promise‹Type[]›
findOne#
▸ findOne(filter: any, context: GraphbackContext): Promise‹Type›
Overrides void
Defined in packages/graphback-datasync/src/providers/DatasyncMongoDBDataProvider.ts:69
Parameters:
| Name | Type |
|---|---|
filter | any |
context | GraphbackContext |
Returns: Promise‹Type›
Protected mapFields#
▸ mapFields(document: any): any
Inherited from DataSyncMongoDBDataProvider.mapFields
Defined in packages/graphback-runtime-mongodb/types/MongoDBDataProvider.d.ts:21
Parameters:
| Name | Type |
|---|---|
document | any |
Returns: any
sync#
▸ sync(lastSync: string, context: GraphbackContext, filter?: any): Promise‹Type[]›
Implementation of DataSyncProvider
Defined in packages/graphback-datasync/src/providers/DatasyncMongoDBDataProvider.ts:106
Parameters:
| Name | Type |
|---|---|
lastSync | string |
context | GraphbackContext |
filter? | any |
Returns: Promise‹Type[]›
update#
▸ update(data: any, context: GraphbackContext): Promise‹Type›
Overrides void
Defined in packages/graphback-datasync/src/providers/DatasyncMongoDBDataProvider.ts:33
Parameters:
| Name | Type |
|---|---|
data | any |
context | GraphbackContext |
Returns: Promise‹Type›