Elastic GraphQL connector reference

Query used to fetch data from the source. Can contain variables provided in the graphql_variables field. The connector will substitute the variables in the query with values from graphql_variables and make a GraphQL query to the source.

Example:

query getUser($id: ID!) {
    user(id: $id) {
        name
        email
    }
}

A JSON object of key/value pairs containing variables used in the GraphQL query. The connector will substitute the variables in the query with the values provided here and make a GraphQL query to the source.

Example:

For the GraphQL query query getUser($id: ID!) { user(id: $id) { name } }

A JSON mapping between GraphQL response objects to index and their ID fields. The connector will fetch data for each object (JSON key) and use the provided ID field (JSON value) to index the object into Elasticsearch. The connector will index all fields for each object specified in the mapping. Use dot (.) notation to specify the full path from the root of the GraphQL response to the desired object.

Example:

The GraphQL query query getUser { organization { users{ user_id name email} } } fetches all available users from the source. To index every user as a separate document configure this field as below.

{
    "organization.users": "user_id"
}

In this example user_id is unique in every user document. Therefore, we set user_id as the value for organization.users.

JSON object containing custom headers to be sent with each GraphQL request:

{
    "content-type": "Application/json"
}

This field specifies the pagination model to be used by the connector. The connector supports No pagination and Cursor-based pagination pagination models.

For cursor-based pagination, add pageInfo {endCursor hasNextPage} and an after argument variable in your query at the desired node (Pagination key). Use the after query argument with a variable to iterate through pages. The default value for this field is No pagination. Example:

For Cursor-based pagination, the query should look like this example:

query getUsers($cursor: String!) {
    sampleData {
        users(after: $cursor) {
            pageInfo {
                endCursor
                hasNextPage
            }
            nodes {
                first_name
                last_name
                address
            }
        }
    }
}

The value of pagination_key is sampleData.users so it must contain:

Specifies which GraphQL object is used for pagination. Use . to provide the full path of the object from the root of the response.

Example: