Collector Files Interface

Introduction to Collector File Interfaces

The following interface contract describes the format and data included in the extracts generated byt the KADA collector.

The interfaces conform to the following specifications:

Property

Value

File Type

CSV

Encoding

UTF-8 (No BOM)

File Delimiter

| (pipe)

Headers

Ordered and present as per contract, all in uppercase. Each header value enclosed in double quotes.

Record Quoting

All fields enclosed in double quotes. Any double quotes inside the field value must be escaped with an additional double quote. e.g. ...|"SELECT ""COLUMN NAME"" from tableA"|...

Metadata Interface

Column-level schema metadata for database objects.

Column

Description

Type

DATABASENAME

Name of the database

String

TYPE

Object type (e.g. TABLE, VIEW)

String

SCHEMANAME

Schema/namespace name

String

TABLENAME

Table or view name

String

COLUMNNAME

Column name

String

DATATYPE

Data type of the column

String

NULLABLE

Whether column allows nulls

String (Y/N)

Metadata Keys Interface

Key constraint metadata — primary keys, foreign keys, and partition keys.

Column

Description

Type

DATABASENAME

Name of the database

String

TYPE

Object type

String

SCHEMANAME

Schema/namespace name

String

TABLENAME

Table name

String

COLUMNNAME

Column name

String

PRIMARY_KEY_FLAG

Whether column is a primary key

String (Y/N)

FOREIGN_KEY_TARGET_SCHEMANAME

Schema of the referenced table

String

FOREIGN_KEY_TARGET_TABLENAME

Referenced table name

String

FOREIGN_KEY_TARGET_COLUMNNAME

Referenced column name

String

PARTITION_KEY_FLAG

Whether column is a partition key

String (Y/N)

Database Log Interface

Query execution logs from the database

Column

Description

Type

DATABASENAME

Name of the database

String

EXECUTION_TIME

When the query was executed

Timestamp

QUERY_ID

Unique query identifier

String

USERNAME

User who ran the query

String

USER_ID

User identifier

String

SCHEMANAME

Default schema at execution time

String

HOST_ID

Host/cluster identifier

String

APP_ID

Application identifier

String

CLIENT_ID

Client tool/driver identifier

String

CLIENT_ADDRESS

IP or hostname of the client

String

SQL_STATEMENT

Full SQL text (whitespace preserved)

String

RUNTIME

Query execution duration

Numeric (String)

ROW_COUNT

Number of rows returned/affected

Integer (String)

SESSION_ID

Database session identifier

String

SESSION_START_TIME

When the session started

Timestamp

SESSION_SOURCE

Origin of the session

String

PROXY_USERNAME

Proxy/impersonated username

String

PROXY_ROLE

Proxy/impersonated role

String

COMPUTE_ID

Compute resource identifier

String

COMPUTE_NAME

Compute resource name

String

SQL_ROW_NO

Row number within a multi-row statement (1 = new statement)

Integer (String)

Roles Interface

Object-level access role assignments.

Column

Description

Type

OBJECT_TYPE

Type of the secured object

String

OBJECT_ID

Identifier of the secured object

String

USER

Username or principal

String

ROLE

Role or permission granted

String

DDL Interface

DDL source code for database objects.

Column

Description

Type

DATABASENAME

Name of the database

String

OBJECT_TYPE

Type of object (TABLE, VIEW, PROCEDURE, etc.)

String

SCHEMANAME

Schema/namespace name

String

OBJECT_NAME

Name of the object

String

OBJECT_DDL

Full DDL text

String

DDL Metadata Interface

Audit and lifecycle metadata for database objects — creation, modification, and access history.

Column

Description

Type

DATABASENAME

Name of the database

String

SCHEMANAME

Schema/namespace name

String

OBJECT_NAME

Name of the object

String

OBJECT_VERSION

Version identifier of the object

String

OBJECT_TYPE

Type of object

String

CREATE_USERNAME

User who created the object

String

CREATE_TIMESTAMP

When the object was created

Timestamp

UPDATE_USERNAME

User who last modified the object

String

UPDATE_TIMESTAMP

When the object was last modified

Timestamp

ACCESS_COUNT

Number of times the object was accessed

Integer (String)

LAST_ACCESS_TIMESTAMP

When the object was last accessed

Timestamp

Users Interface

Basic user account records from the source database or tool.

Column

Description

Type

USERNAME

Login/username

String

FIRST_NAME

First name

String

LAST_NAME

Last name

String

EMAIL

Email address

String

IS_SYSTEM

Whether this is a system/service account

String (Y/N)

USER_ID

Unique user identifier

String

Meta Interface

Catalog metadata for BI/analytics objects such as dashboards, reports, datasets, and queries, and reference objects outside of the source.

Column

Description

Type

OBJECT_TYPE

KADA object type (e.g. CONTENT, DATASET)

String

OBJECT_ID

Unique identifier for the object

String

TOOL_OBJECT_TYPE

Native object type label from the source tool

String

NAME

Display name of the object

String

DESCRIPTION

Description of the object

String

URL

Link to the object in the source tool

String

PATH

Folder/workspace path

String

QUERY_CODE

Underlying query or expression

String

CREATED_AT

Creation timestamp

Timestamp

UPDATED_AT

Last modified timestamp

Timestamp

LAST_RUN_AT

Last execution/refresh timestamp

Timestamp

Linkages Interface

Directed relationships between any two platform objects (lineage, ownership, containment, etc.).

Column

Description

Type

SRC_OBJECT_TYPE

Type of the source object

String

SRC_OBJECT_ID

Identifier of the source object

String

TRG_OBJECT_TYPE

Type of the target object

String

TRG_OBJECT_ID

Identifier of the target object

String

RELATIONSHIP

Relationship type (e.g. OWNER_OF_SRC, CHILD_OF)

String

Events Interface

User activity events against platform objects (views, edits, downloads, etc.).

Column

Description

Type

EXECUTION_TIME

When the event occurred

Timestamp

OBJECT_TYPE

Type of object the event is against

String

OBJECT_ID

Identifier of the object

String

EVENT

Event action (VIEWED, MODIFIED, EXECUTED, etc.)

String

USERNAME

User who triggered the event

String

Properties Interface

Custom key-value properties attached to platform objects. (ie. data type, row count, masking)

Column

Description

Type

OBJECT_TYPE

Type of the object

String

OBJECT_ID

Identifier of the object

String

NAME

Property name/key

String

TYPE

Property data type (BOOLEAN, STRING, INTEGER, JSON)

String

DESCRIPTION

Description of the property

String

VALUE

Property value

String

Metrics Interface

Time-series metric values (e.g. data quality scores) associated with platform objects.

Column

Description

Type

TIMESTAMP

When the metric was recorded

Timestamp

METRIC_TYPE

Type of metric (e.g. DATA_QUALITY_SCORE)

String

RELATED_OBJECT_TYPE

Type of the parent/related object

String

RELATED_OBJECT_ID

Identifier of the parent/related object

String

OBJECT_TYPE

Type of the primary object

String

OBJECT_ID

Identifier of the primary object

String

USER_ID

User associated with the metric (if applicable)

String

VALUE

Metric value

Numeric (String)