Parameter | Type | Description |
---|---|---|
password |
String | The password of the user. |
schemaName |
String | This is the name of the table whose indexes are being returned. |
tableName |
String | This is the name of the schema the table belongs to. |
Parameter | Type | Default Value | Description |
---|---|---|---|
hostName |
String | localhost | Name or IP address of database system where the table resides whose indexes are to be returned. If this parameter is missing, the default value will be "localhost". |
port |
int | 5432 | Port for communicating with the database system where the table resides whose indexes are to be returned. If this parameter is missing, the default value will be "5432". |
database |
String | SIEM | The name of the database in the database system where the table resides whose indexes are to be returned. If this parameter is missing, the default value will be "SIEM". |
userName |
String | appuser | Name of the database user to login to the database system. If this parameter is missing, the default value will be "appuser". |
dbPlatform |
String | postgresql | This is the platform of the database system. It may be <strong>postgresql</strong>, <strong>oracle11g</strong> or <strong>mssql2008</strong>. If this parameter is missing, the default value will be "postgresql". |
Object type: Database table indexes | |
---|---|
Information about the indexes for a given table | |
Field | Description |
indexes | This is a nested JSON object that returns the indexes for the table. Note that it contains a single internal field <B>index</B> that is an array of <B><Table Index></B> objects. See below for description of fields in Table Index objects. |
schemaName | This is the name of the schema the table belongs to. |
tableName | This is the name of the table whose indexes are being returned. |
Object type: Database table indexes | |
---|---|
Further detail on the index fields | |
Field | Description |
indexColumns | This is a nested JSON object that contains the index columns for the index. Note that it contains a single internal field <B>indexColumn</B> that is an array of objects. See below for description of fields in Index Column objects. |
indexName | Name of an index for the table. |
unique | Flag (true or false) indicating whether the index is a unique index. |
Object type: Database table fields | |
---|---|
Information about the indexed columned for a given table | |
Field | Description |
columnName | Name of table column that is to be indexed. |
sortSequence | Value indicating whether the column values are sorted in ascending or descending order. A value of "A" indicates ascending order, and a value of "D" indicates descending order. This may be omitted if neither ascending or descending is applicable. |
GET /datasync/tableindexes?hostName=164.99.19.125&port=5432&userName=appuser&password=star1111&dbPlatform=postgresql&schemaName=my_schema &tableName=my_table_name?hostName=164.99.19.125&port=5432&userName=appuser&password=star1111&dbPlatform=postgresql
{ "tableName": "my_table_name", "schemaName": "my_schema", "indexes": {"index":[{<Table Index>},{<Table Index>}...]} } Table Index Fields { "indexName": "evt_id_index", "indexColumns": {"indexColumn":[{<Index Column>},{<Index Column>}...]}, "unique": "true" } Index Column Fields { "columnName": "evt_id", "sortSequence": "A" }