Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents

Database

Database syntax options are the same for all the supported databases. Supported database syntax are:

  • Hyper SQL 
  • Microsoft SQL
  • MonetDB
  • MySQL 
  • Oracle
  • PostgreSQL
  • Vertica

 

Code Block
titleGet Database Options
http://host/rds/api/package/types/MONET_DB
Code Block
titleDatabase Options
collapsetrue
{
    "objectId": "bf4ee15f-3152-4b40-8877-2f168e24bf71",
    "type": "MONET_DB",
    "optionProperties": [
        {
            "description": "File name",
            "enumValues": [],
            "label": "File name",
            "name": "fileName",
            "type": "TEXT",
            "value": "",
            "repeatable": false,
            "required": true,
            "readOnly": false
        },
        {
            "description": "Bulk import data from a CSV file instead of using insert statements",
            "enumValues": [],
            "label": "Bulk import",
            "name": "bulkImport",
            "type": "BOOLEAN",
            "value": true,
            "repeatable": false,
            "required": false,
            "readOnly": false
        },
        {
            "description": "Creates a table for each classification as well as the fact table which contains all the data",
            "enumValues": [],
            "label": "Create dimension tables",
            "name": "createDimensionTables",
            "type": "BOOLEAN",
            "value": false,
            "repeatable": false,
            "required": false,
            "readOnly": false
        },
        {
            "description": "Database name",
            "enumValues": [],
            "label": "Database name",
            "name": "dbName",
            "type": "TEXT",
            "value": "db_name",
            "repeatable": false,
            "required": true,
            "readOnly": false
        },
        {
            "description": "Specifies that the data should be added to the database script. If false only the table schemas will be created.",
            "enumValues": [],
            "label": "Generate data",
            "name": "generateData",
            "type": "BOOLEAN",
            "value": true,
            "repeatable": false,
            "required": false,
            "readOnly": false
        },
        {
            "description": "Table name",
            "enumValues": [],
            "label": "Table name",
            "name": "tableName",
            "type": "TEXT",
            "value": "table_name",
            "repeatable": false,
            "required": true,
            "readOnly": false
        },
        {
            "description": "Max columns allowed per table, if the table exceeds this number then additional tables will be created and they will need to be pulled together in a view.",
            "enumValues": [],
            "label": "Max columns",
            "name": "maxCols",
            "type": "TEXT",
            "value": 50000,
            "repeatable": false,
            "required": true,
            "readOnly": false
        }
    ]
}

Statistics

Syntax for statistical packages are also available and are typically accompanied by some sort of fixed width or CSV data file. Supported syntax are:

  • R
  • SAS
  • SDA
  • Stata
  • Stat Transfer
  • SPSS

 

Code Block
titleGet Script Options
http://host/rds/api/package/types/R
Code Block
titleScript options
collapsetrue
{
    "objectId": "86023e38-8e3c-4877-abfb-24fe4e91eb20",
    "type": "R",
    "optionProperties": [
        {
            "description": "File name",
            "enumValues": [],
            "label": "File name",
            "name": "fileName",
            "type": "TEXT",
            "value": "",
            "repeatable": false,
            "required": true,
            "readOnly": false
        },
        {
            "description": "The ID of a FIXED | CSV file being packaged that this script will use.",
            "enumValues": [],
            "label": "Data File ID",
            "name": "dataInstanceId",
            "type": "TEXT",
            "value": "",
            "repeatable": false,
            "required": false,
            "readOnly": false
        }
    ]
}