Query records from an Airtable table. Records are incrementally retrieved based on the last modified time of the records. Records can also be further filtered by setting the 'Custom Filter' property which supports the formulas provided by the Airtable API. This processor is intended to be run on the Primary Node only.
airtable, query, database
In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| API URL | api-url | https://api.airtable.com/v0 | The URL for the Airtable REST API including the domain and the path to the API (e.g. https://api.airtable.com/v0). Supports Expression Language: true (will be evaluated using variable registry only) | |
| API Key | api-key | The REST API key to use in queries. Should be generated on Airtable's account page. Sensitive Property: true | ||
| Base ID | base-id | The ID of the Airtable base to be queried. Supports Expression Language: true (will be evaluated using variable registry only) | ||
| Table ID | table-id | The name or the ID of the Airtable table to be queried. Supports Expression Language: true (will be evaluated using variable registry only) | ||
| Fields | fields | Comma-separated list of fields to query from the table. Both the field's name and ID can be used. Supports Expression Language: true (will be evaluated using variable registry only) | ||
| Custom Filter | custom-filter | Filter records by Airtable's formulas. Supports Expression Language: true (will be evaluated using variable registry only) | ||
| Query Time Window Lag | query-time-window-lag | 3 s | The amount of lag to be applied to the query time window's end point. Set this property to avoid missing records when the clock of your local machines and Airtable servers' clock are not in sync. Must be greater than or equal to 1 second. Supports Expression Language: true (will be evaluated using variable registry only) | |
| Web Client Service Provider | web-client-service-provider | Controller Service API: WebClientServiceProvider Implementation: StandardWebClientServiceProvider | Web Client Service Provider to use for Airtable REST API requests | |
| Query Page Size | query-page-size | Number of records to be fetched in a page. Should be between 1 and 100 inclusively. Supports Expression Language: true (will be evaluated using variable registry only) | ||
| Max Records Per FlowFile | max-records-per-flowfile | The maximum number of result records that will be included in a single FlowFile. This will allow you to break up very large result sets into multiple FlowFiles. If no value specified, then all records are returned in a single FlowFile. Supports Expression Language: true (will be evaluated using variable registry only) |
| Name | Description |
|---|---|
| success | For FlowFiles created as a result of a successful query. |
| Name | Description |
|---|---|
| record.count | Sets the number of records in the FlowFile. |
| fragment.identifier | If 'Max Records Per FlowFile' is set then all FlowFiles from the same query result set will have the same value for the fragment.identifier attribute. This can then be used to correlate the results. |
| fragment.count | If 'Max Records Per FlowFile' is set then this is the total number of FlowFiles produced by a single ResultSet. This can be used in conjunction with the fragment.identifier attribute in order to know how many FlowFiles belonged to the same incoming ResultSet. |
| fragment.index | If 'Max Records Per FlowFile' is set then the position of this FlowFile in the list of outgoing FlowFiles that were all derived from the same result set FlowFile. This can be used in conjunction with the fragment.identifier attribute to know which FlowFiles originated from the same query result set and in what order FlowFiles were produced |
| Scope | Description |
|---|---|
| CLUSTER | The last successful query's time is stored in order to enable incremental loading. The initial query returns all the records in the table and each subsequent query filters the records by their last modified time. In other words, if a record is updated after the last successful query only the updated records will be returned in the next query. State is stored across the cluster, so this Processor can run only on the Primary Node and if a new Primary Node is selected, the new node can pick up where the previous one left off without duplicating the data. |