Introduction

The Output Module is a lightweight graph query engine exposed through the public API. It allows different output formats, such as JSON, XML, Excel, and CSV. It also provides a single API to query most of the Collibra entities, such as assets, communities, domains and types, using SQL-like filtering capabilities. You can sort entities using any of the available properties and page results and view permissions for authenticated users who issue REST calls.

Important considerations for the Output Module API

The Output Module API is a powerful interface that provides extensive querying capabilities, similar to direct SQL access to your Collibra database. To ensure efficient usage, it is important to understand the implications of your queries.

This API provides a comprehensive query language, enabling you to join entities, sort by properties, and filter by criteria. While this allows extensive control over data retrieval, inefficient queries can significantly impact system performance, particularly in large and complex environments.

Key considerations:

• Performance testing is important: Given the ability of the API to perform complex queries, you must thoroughly test the performance of your specific queries in a production-like or large-scale environment. Queries that perform well in a smaller test setup may cause significant performance degradation when executed against a large dataset.
• Understand the impact of queries: Similar to SQL, the structure of your queries, the number of joins, the complexity of filters, and the amount of data retrieved will directly affect execution time and resource usage.
• Contact Collibra for assistance: If you encounter performance issues or your queries do not meet your needs in a production environment, contact our implementation and advisory teams. They can help you optimize your queries and use the API effectively.

By understanding these considerations and thoroughly testing your implementations, you can use the Output Module API effectively while ensuring good performance in your Collibra environment.