Interface RecordsPluginMethod<AppConnection>

Callable

• RecordsPluginMethod(argument: { app: App; appId: string; appOptions: SimpleAppOptions; connection: AppConnection; highWaterMark: HighWaterMark; limit: number; properties: Property[]; run: Run; runId: string; schedule: Schedule; scheduleFilters: ScheduleFiltersWithKey[]; scheduleId: string; scheduleOptions: SimpleScheduleOptions; source: Source; sourceId: string; sourceMapping: SourceMapping; sourceOffset: string | number; sourceOptions: SimpleSourceOptions }): Promise<RecordsPluginMethodResponse>

• Method to get one or many records to be saved/updated. Only returns the nextHighWaterMark and a count of how many records were imported. Within this method you should call plugin.createImport()

  Parameters

  • argument: { app: App; appId: string; appOptions: SimpleAppOptions; connection: AppConnection; highWaterMark: HighWaterMark; limit: number; properties: Property[]; run: Run; runId: string; schedule: Schedule; scheduleFilters: ScheduleFiltersWithKey[]; scheduleId: string; scheduleOptions: SimpleScheduleOptions; source: Source; sourceId: string; sourceMapping: SourceMapping; sourceOffset: string | number; sourceOptions: SimpleSourceOptions }

    • app: App

    • appId: string

    • appOptions: SimpleAppOptions

    • connection: AppConnection

    • highWaterMark: HighWaterMark

    • limit: number

    • properties: Property[]

    • run: Run

    • runId: string

    • schedule: Schedule

    • scheduleFilters: ScheduleFiltersWithKey[]

    • scheduleId: string

    • scheduleOptions: SimpleScheduleOptions

    • source: Source

    • sourceId: string

    • sourceMapping: SourceMapping

    • sourceOffset: string | number

    • sourceOptions: SimpleSourceOptions

  Returns Promise<RecordsPluginMethodResponse>