| Parameter | Type | Description |
|---|---|---|
password |
String | The password of the user. |
| Parameter | Type | Default Value | Description |
|---|---|---|---|
hostName |
String | localhost | Name or IP address of database system where the destination table is to be created. If this parameter is missing, the default value will be "localhost". |
port |
int | 5432 | Port for communicating with the database system where the destination table is to be created. 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 destination table is to be created. 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 where the destination table is to be created. If this parameter is missing, the default value will be "appuser". NOTE: This user should have sufficient rights to create a table. |
dbPlatform |
String | postgresql | This is the platform of the database system where the destination table is to be created. 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: Table Sql creation | ||
|---|---|---|
| Information on what table to create | ||
| Field | Required | Description |
| columns | false | This is a nested JSON object that specifies the table columns to be created for the table. Note that it contains a single internal field <B>column</B> that is an array of <B><Column></B> objects. See below for description of fields in Column objects. |
| okToCreateSyncStateTable | false | This is a flag that indicates whether it is ok to also create a sync state table in the destination database. If "true", the sync state table will only be created if it does not already exist. |
| table | false | This is a nested JSON <B><Table></B> object that specifies the destination table that is to be created. See below for description of fields in Table objects. |
| tableIndexes | false | This is a nested JSON object that specifies the indexes to be created for the table. Note that it contains a single internal field <B>tableIndex</B> that is an array of <B><Table Index></B> objects. See below for description of fields in Table Index objects. This field is optional. If missing, no indexes will be created. |
| Object type: Table Sql columns creation | ||
|---|---|---|
| Information on what table fields to create | ||
| Field | Required | Description |
| indexSpace | false | Name of the tablespace in the destination database where the table indexes (if any) are to be created. NOTE: If this field is missing, the default tablespace will be used. |
| schemaName | false | Name of the schema for the destination table that is to be created. NOTE: This is an optional field. It will default to the schema of the database user specified in the "userName" URL parameter. |
| tableName | false | Name of the destination table that is to be created. |
| tableSpace | false | Name of the tablespace in the destination database where the destination table is to be created. NOTE: If this field is missing, the default tablespace will be used. |
| Object type: Table Sql columns creation | ||
|---|---|---|
| Information on what table columns to create | ||
| Field | Required | Description |
| columnName | false | Name of column in the destination table that is to be created. |
| columnSize | false | Size of database column. NOTE: This only applies if the database column is a VARCHAR. |
| columnType | false | Data type of database column. Should be a java.sql.Types value (BIGINT, VARCHAR, etc.). |
| nullable | false | Flag indicating whether database column can have null values. 0=Nulls not allowed, 1=Nulls allowed, 2=Unknown if nulls allowed. |
| Object type: Table Sql index columns creation | ||
|---|---|---|
| Information on what table index columns to create | ||
| Field | Required | Description |
| indexColumns | false | This is a nested JSON object that specifies the index columns. Note that it contains a single internal field indexColumn that is an array of <Index Column> objects. See below for description of fields in Index Column objects. |
| indexName | false | Name of index to be created for the destination table. |
| unique | false | Flag (true or false) indicating whether the index is a unique index. |
| Object type: Table Sql index creation | ||
|---|---|---|
| Information on the index columns to create | ||
| Field | Required | Description |
| columnName | false | Name of index to be created for the destination table. |
| sortSequence | false | Value indicating whether the column values are to be sorted in ascending or descending order. A value of "A" should be used for ascending, and a value of "D" should be used for descending. This may be omitted if neither ascending or descending is applicable. |
| Object type: Create Table status | |
|---|---|
| Details on the table creation | |
| Field | Description |
| schemaName | This is the schema the destination table was created in. |
| tableName | This is the destination table name that was created. |
POST /datasync/table?hostName=164.99.19.125&port=5432&userName=appuser&password=star1111&dbPlatform=postgresql
{ "table": {<Table>}, "columns": {"column":[{<Column>},{<Column>}...]}, "tableIndexes": {"tableIndex":[{<Table Index>},{<Table Index>}...]}, "okToCreateSyncStateTable": "true", } Table Fields { "schemaName": "my_schema", "tableName": "my_event_table", "tableSpace": "tablespace1", "indexSpace": "tablespace2", } Column Fields { "columnName": "msg", "columnType": "12", "nullable": "1", "columnSize": "4000" } Table Index Fields { "indexName": "evt_id_index", "indexColumns": {"indexColumn":[{<Index Column>},{<Index Column>}...]}, "unique": "true" } Index Column Fields { "columnName": "evt_id", "sortSequence": "A" }
{ "schemaName": "my_schema", "tableName": "my_event_table", }