DataSyncPlugin
DataSync plugin
Plugin is enabled by """ @datasync """ annotation It will generate delta queries
Hierarchy
GraphbackPlugin
↳ DataSyncPlugin
Index
Constructors
Properties
Methods
- addDataSyncFieldsToInputTypes
- addDataSyncFieldsToModel
- addDeltaQuery
- addDeltaSyncResolver
- createResolvers
- createResources
- getDeltaTypeFieldNames
- getPluginName
- logError
- logWarning
- transformSchema
Constructors
constructor
+ new DataSyncPlugin(config?: DataSyncPluginConfig): DataSyncPlugin
Defined in packages/graphback-datasync/src/DataSyncPlugin.ts:21
Parameters:
| Name | Type |
|---|---|
config? | DataSyncPluginConfig |
Returns: DataSyncPlugin
Properties
Protected config
• config: DataSyncPluginConfig
Defined in packages/graphback-datasync/src/DataSyncPlugin.ts:21
Methods
Protected addDataSyncFieldsToInputTypes
▸ addDataSyncFieldsToInputTypes(schemaComposer: SchemaComposer‹any›, model: ModelDefinition): void
Defined in packages/graphback-datasync/src/DataSyncPlugin.ts:145
Parameters:
| Name | Type |
|---|---|
schemaComposer | SchemaComposer‹any› |
model | ModelDefinition |
Returns: void
Protected addDataSyncFieldsToModel
▸ addDataSyncFieldsToModel(schemaComposer: SchemaComposer‹any›, model: ModelDefinition): void
Defined in packages/graphback-datasync/src/DataSyncPlugin.ts:123
Parameters:
| Name | Type |
|---|---|
schemaComposer | SchemaComposer‹any› |
model | ModelDefinition |
Returns: void
Protected addDeltaQuery
▸ addDeltaQuery(schemaComposer: SchemaComposer‹unknown›, model: ModelDefinition): void
Defined in packages/graphback-datasync/src/DataSyncPlugin.ts:159
Parameters:
| Name | Type |
|---|---|
schemaComposer | SchemaComposer‹unknown› |
model | ModelDefinition |
Returns: void
Protected addDeltaSyncResolver
▸ addDeltaSyncResolver(model: ModelDefinition, queryObj: IFieldResolver‹any, any›): void
Defined in packages/graphback-datasync/src/DataSyncPlugin.ts:106
Parameters:
| Name | Type |
|---|---|
model | ModelDefinition |
queryObj | IFieldResolver‹any, any› |
Returns: void
createResolvers
▸ createResolvers(metadata: GraphbackCoreMetadata): IResolvers
Overrides void
Defined in packages/graphback-datasync/src/DataSyncPlugin.ts:76
Creates resolvers for Data Synchonization
Parameters:
| Name | Type | Description |
|---|---|---|
metadata | GraphbackCoreMetadata | Core metatata containing all model information |
Returns: IResolvers
createResources
▸ createResources(metadata: GraphbackCoreMetadata): void
Overrides void
Defined in packages/graphback-datasync/src/DataSyncPlugin.ts:95
Parameters:
| Name | Type |
|---|---|
metadata | GraphbackCoreMetadata |
Returns: void
Private getDeltaTypeFieldNames
▸ getDeltaTypeFieldNames(modelTC: GraphQLObjectType): string[]
Defined in packages/graphback-datasync/src/DataSyncPlugin.ts:202
Parameters:
| Name | Type |
|---|---|
modelTC | GraphQLObjectType |
Returns: string[]
getPluginName
▸ getPluginName(): string
Overrides void
Defined in packages/graphback-datasync/src/DataSyncPlugin.ts:102
Returns: string
Protected logError
▸ logError(message: string): void
Inherited from DataSyncPlugin.logError
Defined in packages/graphback-core/types/plugin/GraphbackPlugin.d.ts:37
Parameters:
| Name | Type |
|---|---|
message | string |
Returns: void
Protected logWarning
▸ logWarning(message: string): void
Inherited from DataSyncPlugin.logWarning
Defined in packages/graphback-core/types/plugin/GraphbackPlugin.d.ts:36
Parameters:
| Name | Type |
|---|---|
message | string |
Returns: void
transformSchema
▸ transformSchema(metadata: GraphbackCoreMetadata): GraphQLSchema
Overrides void
Defined in packages/graphback-datasync/src/DataSyncPlugin.ts:31
Parameters:
| Name | Type |
|---|---|
metadata | GraphbackCoreMetadata |
Returns: GraphQLSchema