Using Compass query APIs

With Compass APIs, you can query and retrieve data that is stored in the data objects from Data Lake.

To run a query and get the results you can use these methods:

  • Post a Compass job to receive a unique Query ID for the job.
  • Get the status of a job using the Compass status method and Query ID for the job.
  • Get the results of a finished job using the Compass results method and the Query ID for the job.

Interface and consumption methods are exposed through the Compass endpoint registered within the ION API Suite for Infor Data Fabric.

How to use ION APIs and how to interact with Swagger documentation for the API methods, see the Infor ION API Administration Guide.

For more details on Data Lake Compass and querying data objects, see Querying the Data Lake

Note: 
  • Compass APIs are not available in AWS GovCloud.
  • Compass version 2 APIs are available in the Infor Data Fabric ION API Suite. Compass version 1 APIs remain in the Infor ION API Suite.
  • Compass V2 APIs are intended to replace the prior version and bring these new capabilities to the functionality:
    • Pagination
    • Limit parameter
    • Offset parameter

    Version 1 returns a full result set in the /result call. In Version 2 the result set is retrieved in row sets or pages.

    The selection parameters Limit and Offset on the rows of the result can be used in V2 at /result method level only.

  • Compass Version 1 and Version 2 APIs are deprecated in ION API Suite and are removed in October 2023. We recommend that you use the Compass endpoint from the Infor Data Fabric suite instead.

The version 2 Compass APIs provide a method to query Compass and return the results in smaller, more manageable, record sets.

You can select an optimal size to download query results based on hardware constraints and network timeouts. You can also re-retrieve a portion of the result in the event of a connection failure. The result of a query is static. The result does not change when data is added or updated in Data Lake. The page size is based on rows, with a maximum limit of 100,000 rows with a 10 MB size cap. The version 2 Compass APIs functionality uses offset and limit parameters for the result set retrieved. Query results are available for roughly 20 hours after receiving the FINISHED status. The query is associated with the method used to run the query. Consequently, you cannot run a query in the Compass UI and then check the status or retrieve the results through the API. The query is only available to the tenant and principal ID that submitted the job. If you run a query, then someone else cannot query for the status or retrieve the results.

This table shows the imposed quotas per tenant:

Method Calls

/v2/compass/jobs

up to 100 calls per minute

/v2/compass/status

up to 1000 calls per minute

/v2/compass/result

 up to 10000 calls per minute

/v2/compass/cancel

up to 1000 calls per minute