teradataml 20.0.0.8__py3-none-any.whl

teradataml/data/jsons/tableoperator/17.20/IMAGE2MATRIX.json

@@ -0,0 +1,53 @@
+{
+"json_schema_major_version": "1",
+"json_schema_minor_version": "0",
+"json_content_version": "1",
+"function_name": "TD_IMAGE2MATRIX",
+"function_version": "1.0",
+"function_type": "table_operator",
+"function_alias_name": "Image2Matrix",
+"function_r_name": "aa.td_image2matrix",
+"ref_function_r_name": "aa.td_image2matrix",
+"supports_view": false,
+"short_description": "Converts an image to a matrix.",
+"long_description": "The function takes input with BLOBs that contain JPEG or PNG images. The image size cannot be greater than (16MB - 4096 bytes), and should not exceed 4,000,000 pixels.",
+"input_tables": [
+        {
+                "requiredInputKind": [
+                   "PartitionByKey"
+                ],
+                "isOrdered": false,
+                "isLocalOrdered": true,
+                "partitionByOne": false,
+                "hashByKey": true,
+                "name": "input",
+                "alternateNames": [],
+                "isRequired": true,
+                "rDescription": "Specifies the teradataml DataFrame containing the imageTable",
+                "description": "Specifies the table containing the input imageTable",
+                "datatype": "TABLE_ALIAS",
+                "allowsLists": false,
+                "rName": "data",
+                "useInR": true,
+                "rOrderNum": 1
+        }
+],
+"argument_clauses": [
+        {
+        "defaultValue": "gray",
+        "permittedValues": ["gray", "rgb"],
+        "isOutputColumn": false,
+        "alternateNames": [],
+        "name": "OUTPUT",
+        "isRequired": false,
+        "rDescription": "If the OUTPUT option is gray, then the output columns are Y, X, and GRAY, where GRAY is the gray image value. If the OUTPUT option is rgb, then the output columns are Y, X, RED, GREEN, and BLUE.",
+        "description": "If the OUTPUT option is gray, then the output columns are Y, X, and GRAY, where GRAY is the gray image value. If the OUTPUT option is rgb, then the output columns are Y, X, RED, GREEN, and BLUE.",
+        "datatype": "STRING",
+        "allowsLists": false,
+        "rName": "output",
+        "useInR": true,
+        "rOrderNum": 2
+        }
+      ]
+}
+    

teradataml/data/jsons/tableoperator/17.20/read_nos.json

@@ -0,0 +1,183 @@
+{
+  "json_schema_major_version": "1",
+  "json_schema_minor_version": "0",
+  "json_content_version": "1",
+  "function_name": "read_nos",
+  "function_version": "1.0",
+  "function_type": "table_operator",
+  "function_alias_name": "read_nos",
+  "function_r_name": "read.nos",
+  "short_description": "This function enables access to external files in JSON, CSV, or Parquet format.",
+  "long_description": "This function enables access to external files in JSON, CSV, or Parquet format. You must have the EXECUTE FUNCTION privilege on TD_SYSFNLIB.READ_NOS.",
+  "input_tables": [
+    {
+      "requiredInputKind": [
+        "PartitionByAny"
+      ],
+      "isOrdered": false,
+      "partitionByOne": false,
+      "name": "input",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies the teradataml DataFrame containing the input data.",
+      "description": "Specifies the table containing the input data.",
+      "datatype": "TABLE_ALIAS",
+      "allowsLists": false,
+      "rName": "data",
+      "useInR": true,
+      "rOrderNum": 1
+    }
+  ],
+  "argument_clauses": [
+    {
+      "permittedValues": [],
+      "isOutputColumn": false,
+      "name": "LOCATION",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies the location value, which is a Uniform Resource Identifier (URI) pointing to the data in the external object storage system. The location value includes the following components:\nAmazon S3: /connector/bucket.endpoint/[key_prefix].\nAzure Blob storage and Azure Data Lake Storage Gen2: /connector/container.endpoint/[key_prefix].\nGoogle Cloud Storage: /connector/endpoint/bucket/[key_prefix].\nconnector: Identifies the type of external storage system where the data is located. Teradata requires the storage location to start with the following for all external storage locations:\nAmazon S3 storage location must begin with /S3 or /s3\nAzure Blob storage location (including Azure Data Lake Storage Gen2 in Blob Interop Mode) must begin with /AZ or /az\nGoogle Cloud Storage location must begin with /GS or /gs.\nendpoint: A URL that identifies the system-specific entry point for the external object storage system.\nbucket (Amazon S3, Google Cloud Storage) or container (Azure Blob storage and Azure Data Lake Storage Gen2): A container that logically groups stored objects in the external storage system.\nkey_prefix: Identifies one or more objects in the logical organization of the bucket data. Because it is a key prefix, not an actual directory path, the key prefix may match one or more objects in the external storage. For example, the key prefix '/fabrics/cotton/colors/b/' would match objects: /fabrics/cotton/colors/blue, /fabrics/cotton/colors/brown, and /fabrics/cotton/colors/black. If there were organization levels below those, such as /fabrics/cotton/colors/blue/shirts, the same key prefix would gather those objects too.\nNote: Vantage validates only the first file it encounters from the location key prefix.\nFor example, this location value might specify all objects on an Amazon cloud storage system for the month of December, 2001:\nlocation = '/S3/YOUR-BUCKET.s3.amazonaws.com/csv/US-Crimes/csv-files/2001/Dec/'\nconnector: S3, bucket: YOUR-BUCKET, endpoint:s3.amazonaws.com, key_prefix: csv/US-Crimes/csv-files/2001/Dec/\nThis location could specify an individual storage object (or file), Day1.csv:\nlocation = '/S3/YOUR-BUCKET.s3.amazonaws.com/csv/US-Crimes/csv-files/2001/Dec/Day1.csv'\nconnector: S3, bucket: YOUR-BUCKET, endpoint:s3.amazonaws.com, key_prefix: csv/US-Crimes/csv-files/2001/Dec/Day11.csv\nThis location specifies an entire container in an Azure external object store (Azure Blob storage or Azure Data Lake Storage Gen2). The container may contain multiple file objects:\nlocation = '/AZ/YOUR-STORAGE-ACCOUNT.blob.core.windows.net/nos-csv-data'\nconnector: AZ, bucket: YOUR-STORAGE-ACCOUNT, endpoint: blob.core.windows.net, key_prefix: nos-csv-data\nThis is an example of a Google Cloud Storage location:\nconnector: GS, bucket: YOUR-BUCKET, endpoint: storage.googleapis.com, key_prefix: CSVDATA/RIVERS/rivers.csv",
+      "description": "Specifies the location value, which is a Uniform Resource Identifier (URI) pointing to the data in the external object storage system. The location value includes the following components:\nAmazon S3: /connector/bucket.endpoint/[key_prefix].\nAzure Blob storage and Azure Data Lake Storage Gen2: /connector/container.endpoint/[key_prefix].\nGoogle Cloud Storage: /connector/endpoint/bucket/[key_prefix].\nconnector: Identifies the type of external storage system where the data is located. Teradata requires the storage location to start with the following for all external storage locations:\nAmazon S3 storage location must begin with /S3 or /s3\nAzure Blob storage location (including Azure Data Lake Storage Gen2 in Blob Interop Mode) must begin with /AZ or /az\nGoogle Cloud Storage location must begin with /GS or /gs.\nendpoint: A URL that identifies the system-specific entry point for the external object storage system.\nbucket (Amazon S3, Google Cloud Storage) or container (Azure Blob storage and Azure Data Lake Storage Gen2): A container that logically groups stored objects in the external storage system.\nkey_prefix: Identifies one or more objects in the logical organization of the bucket data. Because it is a key prefix, not an actual directory path, the key prefix may match one or more objects in the external storage. For example, the key prefix '/fabrics/cotton/colors/b/' would match objects: /fabrics/cotton/colors/blue, /fabrics/cotton/colors/brown, and /fabrics/cotton/colors/black. If there were organization levels below those, such as /fabrics/cotton/colors/blue/shirts, the same key prefix would gather those objects too.\nNote: Vantage validates only the first file it encounters from the location key prefix.\nFor example, this location value might specify all objects on an Amazon cloud storage system for the month of December, 2001:\nlocation = '/S3/YOUR-BUCKET.s3.amazonaws.com/csv/US-Crimes/csv-files/2001/Dec/'\nconnector: S3, bucket: YOUR-BUCKET, endpoint:s3.amazonaws.com, key_prefix: csv/US-Crimes/csv-files/2001/Dec/\nThis location could specify an individual storage object (or file), Day1.csv:\nlocation = '/S3/YOUR-BUCKET.s3.amazonaws.com/csv/US-Crimes/csv-files/2001/Dec/Day1.csv'\nconnector: S3, bucket: YOUR-BUCKET, endpoint:s3.amazonaws.com, key_prefix: csv/US-Crimes/csv-files/2001/Dec/Day11.csv\nThis location specifies an entire container in an Azure external object store (Azure Blob storage or Azure Data Lake Storage Gen2). The container may contain multiple file objects:\nlocation = '/AZ/YOUR-STORAGE-ACCOUNT.blob.core.windows.net/nos-csv-data'\nconnector: AZ, bucket: YOUR-STORAGE-ACCOUNT, endpoint: blob.core.windows.net, key_prefix: nos-csv-data\nThis is an example of a Google Cloud Storage location:\nconnector: GS, bucket: YOUR-BUCKET, endpoint: storage.googleapis.com, key_prefix: CSVDATA/RIVERS/rivers.csv",
+      "datatype": "STRING",
+      "allowsLists": false,
+      "rName": "location",
+      "useInR": true,
+      "rOrderNum": 2
+    },
+    {
+      "permittedValues": [],
+      "isOutputColumn": false,
+      "name": "AUTHORIZATION",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies the authorization for accessing external storage. On any platform, you can specify an authorization object ([DatabaseName.]AuthorizationObjectName). You must have the EXECUTE privilege on AuthorizationObjectName. On Amazon S3 and Azure Blob storage and Azure Data Lake Storage Gen2, you can specify either an authorization object or a string in JSON format. The string specifies the USER (identification) and PASSWORD (secret_key) for accessing external storage. The following table shows the supported credentials for USER and PASSWORD (used in the CREATE AUTHORIZATION command):\n\nSystem/Scheme                       |USER                           |PASSWORD\nAWS                                 |Access Key ID                  |Access Key Secret\nAzure / Shared Key                  |Storage Account Name           |Storage Account Key\nAzure Shared Access Signature (SAS) |Storage Account Name           |Account SAS Token\nGoogle Cloud (S3 interop mode)      |Access Key ID                  |Access Key Secret\nGoogle Cloud (native)               |Client Email                   |Private Key\nOn-premises object stores           |Access Key ID                  |Access Key Secret\nPublic access object stores         |<empty string>                 |<empty string>\n                                    |Enclose the empty string in    |Enclose the empty string in\n                                    |single straight quotes: USER ''| single straight quotes: PASSWORD ''\nIf you use a function mapping to define a wrapper for READ_NOS, you can specify the authorization in the function mapping. Note that [ INVOKER | DEFINER ] TRUSTED must be used with function mapping. If you are using AWS IAM credentials, you can omit the AUTHORIZATION clause. When accessing GCS, Advanced SQL Engine uses either the S3-compatible connector or the native Google connector, depending on the user credentials.",
+      "description": "Specifies the authorization for accessing external storage. On any platform, you can specify an authorization object ([DatabaseName.]AuthorizationObjectName). You must have the EXECUTE privilege on AuthorizationObjectName. On Amazon S3 and Azure Blob storage and Azure Data Lake Storage Gen2, you can specify either an authorization object or a string in JSON format. The string specifies the USER (identification) and PASSWORD (secret_key) for accessing external storage. The following table shows the supported credentials for USER and PASSWORD (used in the CREATE AUTHORIZATION command):\n\nSystem/Scheme                       |USER                           |PASSWORD\nAWS                                 |Access Key ID                  |Access Key Secret\nAzure / Shared Key                  |Storage Account Name           |Storage Account Key\nAzure Shared Access Signature (SAS) |Storage Account Name           |Account SAS Token\nGoogle Cloud (S3 interop mode)      |Access Key ID                  |Access Key Secret\nGoogle Cloud (native)               |Client Email                   |Private Key\nOn-premises object stores           |Access Key ID                  |Access Key Secret\nPublic access object stores         |<empty string>                 |<empty string>\n                                    |Enclose the empty string in    |Enclose the empty string in\n                                    |single straight quotes: USER ''| single straight quotes: PASSWORD ''\nIf you use a function mapping to define a wrapper for READ_NOS, you can specify the authorization in the function mapping. Note that [ INVOKER | DEFINER ] TRUSTED must be used with function mapping. If you are using AWS IAM credentials, you can omit the AUTHORIZATION clause. When accessing GCS, Advanced SQL Engine uses either the S3-compatible connector or the native Google connector, depending on the user credentials.",
+      "datatype": ["STRING", "JSON"],
+      "allowsLists": false,
+      "rName": "authorization",
+      "useInR": true,
+      "rOrderNum": 3
+    },
+    {
+      "permittedValues": ["NOSREAD_RECORD", "NOSREAD_KEYS", "NOSREAD_SCHEMA", "NOSREAD_PARQUET_SCHEMA"],
+      "defaultValue": "NOSREAD_RECORD",
+      "isOutputColumn": false,
+      "name": "RETURNTYPE",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies the format in which data is returned.\nNOSREAD_RECORD: Returns one row for each external record along with its metadata. This is the default. Access external records by specifying one of the following:\n* Input table and location and an empty table. For CSV, you can include a schema definition.\n* Input table with a row for each external file. For CSV, this method does not support a schema definition.\nFor an empty single-column input table, do the following:\n* Define an input table with a single column, Payload, with the appropriate data type: JSON and DATASET with a Storage Format of CSV. This column determines the output Payload column return type.\n* For location, specify the filepath.\nFor a multiple-column input table, define an input table with the following columns:\n* Location VARCHAR(2048) CHARACTER SET UNICODE\n* ObjectVersionID VARCHAR(1024) CHARACTER SET UNICODE\n* ObjectVersionID VARCHAR(1024) CHARACTER SET UNICODE\n* OffsetIntoObject BIGINT\n* ObjectLength BIGINT\n* Payload JSON or VARCHAR for CSV\nThis table can be populated using the output of the NOSREAD_KEYS return type.\nNOSREAD_KEYS: Retrieve the list of files from the path specified in the LOCATION USING clause. A schema definition is not necessary. Returns: Location, ObjectVersionID, ObjectTimeStamp, ObjectLength, size of external file.",
+      "description": "Specifies the format in which data is returned.\nNOSREAD_RECORD: Returns one row for each external record along with its metadata. This is the default. Access external records by specifying one of the following:\n* Input table and location and an empty table. For CSV, you can include a schema definition.\n* Input table with a row for each external file. For CSV, this method does not support a schema definition.\nFor an empty single-column input table, do the following:\n* Define an input table with a single column, Payload, with the appropriate data type: JSON and DATASET with a Storage Format of CSV. This column determines the output Payload column return type.\n* For location, specify the filepath.\nFor a multiple-column input table, define an input table with the following columns:\n* Location VARCHAR(2048) CHARACTER SET UNICODE\n* ObjectVersionID VARCHAR(1024) CHARACTER SET UNICODE\n* ObjectVersionID VARCHAR(1024) CHARACTER SET UNICODE\n* OffsetIntoObject BIGINT\n* ObjectLength BIGINT\n* Payload JSON or VARCHAR for CSV\nThis table can be populated using the output of the NOSREAD_KEYS return type.\nNOSREAD_KEYS: Retrieve the list of files from the path specified in the LOCATION USING clause. A schema definition is not necessary. Returns: Location, ObjectVersionID, ObjectTimeStamp, ObjectLength, size of external file.", 
+      "datatype": "STRING",
+      "allowsLists": false,
+      "rName": "return.type",
+      "useInR": true,
+      "rOrderNum": 4
+    },
+    {
+      "permittedValues": [],
+      "defaultValue": 1.0,
+      "lowerBound": 0.0,
+      "upperBound": 1.0,
+      "lowerBoundType": "INCLUSIVE",
+      "upperBoundType": "INCLUSIVE",
+      "isOutputColumn": false,
+      "name": "SAMPLE_PERC",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies the percentage of rows to retrieve from the external storage repository when return.type is NOSREAD_RECORD. The valid range of values is from '0.0' to '1.0', where '1.0' represents 100% of the rows. The default value is 1.0.",
+      "description": "Specifies the percentage of rows to retrieve from the external storage repository when return.type is NOSREAD_RECORD. The valid range of values is from '0.0' to '1.0', where '1.0' represents 100% of the rows. The default value is 1.0.",
+      "datatype": "DOUBLE PRECISION",
+      "allowsLists": false,
+      "rName": "sample.perc",
+      "useInR": true,
+      "rOrderNum": 5
+    },
+    {
+      "permittedValues": ["PARQUET", "TEXTFILE"],
+      "defaultValue": "TEXTFILE",
+      "isOutputColumn": false,
+      "name": "STOREDAS",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies the formatting style of the external data.\nPARQUET means the external data is formatted as Parquet. This is a required parameter for Parquet data.\nTEXTFILE means the external data uses a text-based format, such as CSV or JSON.\nThe default is TEXTFILE.",
+      "description": "Specifies the formatting style of the external data.\nPARQUET means the external data is formatted as Parquet. This is a required parameter for Parquet data.\nTEXTFILE means the external data uses a text-based format, such as CSV or JSON.\nThe default is TEXTFILE.",
+      "datatype": "STRING",
+      "allowsLists": false,
+      "rName": "stored.as",
+      "useInR": true,
+      "rOrderNum": 6
+    },
+    {
+      "permittedValues": [],
+      "isOutputColumn": false,
+      "name": "SCANPCT",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies the percentage of data to scans to discover the schema.",
+      "description": "Specifies the percentage of data to scans to discover the schema.",
+      "datatype": "DOUBLE PRECISION",
+      "allowsLists": false,
+      "rName": "scan.pct",
+      "useInR": true,
+      "rOrderNum": 7
+    },
+    {
+      "permittedValues": [],
+      "defaultValue": false,
+      "isOutputColumn": false,
+      "name": "MANIFEST",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies whether the location value points to a manifest file (a file containing a list of files to read) or object name. The object name can include the full path or a partial path. It must identify a single file containing the manifest. Note: The individual entries within the manifest file must show complete paths. Below is an example of a manifest file that contains a list of entries to locations in JSON format\n{\n  \"entries\": [\n      {\"url\":\"s3://nos-core-us-east-1/UNICODE/JSON/mln-key/data-10/data-8_9_02-10.json\"},\n      {\"url\":\"s3://nos-core-us-east-1/UNICODE/JSON/mln-key/data-10/data-8_9_02-101.json\"},\n      {\"url\":\"s3://nos-core-us-east-1/UNICODE/JSON/mln-key/data-10/data-10-01/data-8_9_02-102.json\"},\n      {\"url\":\"s3://nos-core-us-east-1/UNICODE/JSON/mln-key/data-10/data-10-01/data-8_9_02-103.json\"}\n   ]\n}",
+      "description": "Specifies whether the LOCATION value points to a manifest file (a file containing a list of files to read) or object name. The object name can include the full path or a partial path. It must identify a single file containing the manifest. Note: The individual entries within the manifest file must show complete paths. Below is an example of a manifest file that contains a list of entries to locations in JSON format\n{\n  \"entries\": [\n      {\"url\":\"s3://nos-core-us-east-1/UNICODE/JSON/mln-key/data-10/data-8_9_02-10.json\"},\n      {\"url\":\"s3://nos-core-us-east-1/UNICODE/JSON/mln-key/data-10/data-8_9_02-101.json\"},\n      {\"url\":\"s3://nos-core-us-east-1/UNICODE/JSON/mln-key/data-10/data-10-01/data-8_9_02-102.json\"},\n      {\"url\":\"s3://nos-core-us-east-1/UNICODE/JSON/mln-key/data-10/data-10-01/data-8_9_02-103.json\"}\n   ]\n}",
+      "datatype": "BOOLEAN",
+      "allowsLists": false,
+      "rName": "manifest",
+      "useInR": true,
+      "rOrderNum": 8
+    },
+    {
+      "permittedValues": ["DELTALAKE"],
+      "isOutputColumn": false,
+      "name": "TABLE_FORMAT",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies the table format of the tables specified in manifest file.",
+      "description": "Specifies the table format of the tables specified in manifest file.",
+      "datatype": "STRING",
+      "allowsLists": false,
+      "rName": "table.format",
+      "langName": "table_format",
+      "useInR": true,
+      "rOrderNum": 9
+    },
+    {
+      "permittedValues": [],
+      "isOutputColumn": false,
+      "name": "ROWFORMAT",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies the encoding format of the external row, for example:\nrow.format = '{\"field_delimiter\":\",\", \"record_delimiter\":\"\n\", \"character_set\":\"LATIN\"}'.\nSpecify row_format using JSON format. It can include only the three keys shown above. Key names and values are case-specific, except for the value for \"character_set\", which can use any combination of letter cases.\nThe row.format character set specification must be compatible with character set of the Payload column. Do not specify row.format for Parquet format data. For a JSON column, these are the default values:\nUNICODE: row.format = '{\"record_delimiter\":\"\n\", \"character_set\":\"UTF8\"}'\nLATIN: row.format = '{\"record_delimiter\":\"\n\", \"character_set\":\"LATIN\"}'\nFor a CSV column, these are the default values:\nUNICODE: row.format = '{\"character_set\":\"UTF8\"}'\nThis is the default if you do not specify an input table for read.nos.\nLATIN: row.format = '{\"character_set\":\"LATIN\"}'\nYou can specify the following options:\nfield_delimiter-> The default is ',' (comma). You can also specify a custom field delimiter, such as tab '\t'.\nrecord_delimiter-> New line feed character: '\n'. A line feed (\n) is the only acceptable record delimiter.\ncharacter_set -> 'UTF8' or 'LATIN'. If you do not specify a row.format or payload column, Vantage assumes UTF8 Unicode.",
+      "description": "Specifies the encoding format of the external row, for example:\nROWFORMAT('{\"field_delimiter\":\",\", \"record_delimiter\":\"\n\", \"character_set\":\"LATIN\"}').\nSpecify ROWFORMAT using JSON format. It can include only the three keys shown above. Key names and values are case-specific, except for the value for \"character_set\", which can use any combination of letter cases.\nThe ROWFORMAT character set specification must be compatible with character set of the Payload column. Do not specify ROWFORMAT for Parquet format data. For a JSON column, these are the default values:\nUNICODE: ROWFORMAT('{\"record_delimiter\":\"\n\", \"character_set\":\"UTF8\"}')\nLATIN: ROWFORMAT('{\"record_delimiter\":\"\n\", \"character_set\":\"LATIN\"}')\nFor a CSV column, these are the default values:\nUNICODE: ROWFORMAT('{\"character_set\":\"UTF8\"}')\nThis is the default if you do not specify an input table for READ_NOS.\nLATIN: ROWFORMAT('{\"character_set\":\"LATIN\"}')\nYou can specify the following options:\nfield_delimiter-> The default is ',' (comma). You can also specify a custom field delimiter, such as tab '\t'.\nrecord_delimiter-> New line feed character: '\n'. A line feed (\n) is the only acceptable record delimiter.\ncharacter_set -> 'UTF8' or 'LATIN'. If you do not specify a ROWFORMAT or payload column, Vantage assumes UTF8 Unicode.",
+      "datatype": ["STRING", "JSON"],
+      "allowsLists": false,
+      "rName": "row.format",
+      "useInR": true,
+      "rOrderNum": 10
+    },
+    {
+      "permittedValues": [],
+      "defaultValue": true,
+      "isOutputColumn": false,
+      "name": "HEADER",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies whether the first row of data in an input CSV file is interpreted as column headings for the subsequent rows of data. Use this parameter only when a CSV input file is not associated with a separate schema object that defines columns for the CSV data. The value for header can be 'True' or 'False'. The default is 'True'.",
+      "description": "Specifies whether the first row of data in an input CSV file is interpreted as column headings for the subsequent rows of data. Use this parameter only when a CSV input file is not associated with a separate schema object that defines columns for the CSV data. The value for HEADER can be 'TRUE' or 'FALSE'. The default is 'TRUE'.",
+      "datatype": "BOOLEAN",
+      "allowsLists": false,
+      "rName": "header",
+      "useInR": true,
+      "rOrderNum": 11
+    }
+  ]
+}

teradataml/data/jsons/tableoperator/17.20/write_nos.json

@@ -0,0 +1,224 @@
+{
+  "json_schema_major_version": "1",
+  "json_schema_minor_version": "0",
+  "json_content_version": "1",
+  "function_name": "write_nos",
+  "function_version": "1.0",
+  "function_type": "table_operator",
+  "function_alias_name": "write_nos",
+  "function_r_name": "write.nos",
+  "supports_view": false,
+  "short_description": "This function enables access to write data from Vantage to external storage, like Amazon S3, Azure Blob storage, or Google Cloud Storage.",
+  "long_description": "This function enables access to write data from Vantage to external storage, like Amazon S3, Azure Blob storage, or Google Cloud Storage. You must have the EXECUTE FUNCTION privilege on TD_SYSFNLIB.WRITE_NOS.",
+  "input_tables": [
+    {
+      "requiredInputKind": [
+        "PartitionByKey"
+      ],
+      "isOrdered": false,
+      "isLocalOrdered": true,
+      "partitionByOne": false,
+      "hashByKey": true,
+      "name": "input",
+      "alternateNames": [],
+      "isRequired": true,
+      "rDescription": "Specifies the teradataml DataFrame containing the input data which will be written to external storage.",
+      "description": "Specifies the table containing the input data which will be written to external storage.",
+      "datatype": "TABLE_ALIAS",
+      "allowsLists": false,
+      "rName": "data",
+      "useInR": true,
+      "rOrderNum": 1
+    }
+  ],
+  "argument_clauses": [
+    {
+      "permittedValues": [],
+      "isOutputColumn": false,
+      "name": "LOCATION",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies the location value, which is a Uniform Resource Identifier (URI) pointing to location in the external object storage system.\nA URI identifying the external storage system in the format:\n /connector/endpoint/bucket_or_container/prefix \nThe LOCATION string cannot exceed 2048 characters.",
+      "description": "Specifies the location value, which is a Uniform Resource Identifier (URI) pointing to location in the external object storage system.\nA URI identifying the external storage system in the format:\n /connector/endpoint/bucket_or_container/prefix \nThe LOCATION string cannot exceed 2048 characters.",
+      "datatype": "STRING",
+      "allowsLists": false,
+      "rName": "location",
+      "useInR": true,
+      "rOrderNum": 2
+    },
+    {
+      "permittedValues": [],
+      "isOutputColumn": false,
+      "name": "AUTHORIZATION",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies the authorization for accessing the external storage. On any platform, you can specify an authorization object ([DatabaseName.]AuthorizationObjectName). You must have the EXECUTE privilege on AuthorizationObjectName.\nOn Amazon S3 and Azure Blob storage and Azure Data Lake Storage Gen2, you can specify either an authorization object or a string in JSON format. The string specifies the USER (identification) and PASSWORD (secret_key) for accessing external storage. The following table shows the supported credentials for USER and PASSWORD (used in the CREATE AUTHORIZATION command):\nSystem/Scheme                       |USER                           |PASSWORD\nAWS                                 |Access Key ID                  |Access Key Secret\nAzure / Shared Key                  |Storage Account Name           |Storage Account Key\nAzure Shared Access Signature (SAS) |Storage Account Name           |Account SAS Token\nGoogle Cloud (S3 interop mode)      |Access Key ID                  |Access Key Secret\nGoogle Cloud (native)               |Client Email                   |Private Key\nOn-premises object stores           |Access Key ID                  |Access Key Secret\nPublic access object stores         |<empty string>                 |<empty string>\n                                    |Enclose the empty string in    |Enclose the empty string in\n                                    |single straight quotes: USER ''| single straight quotes: PASSWORD ''\nIf you use a function mapping to define a wrapper for READ_NOS, you can specify the authorization in the function mapping. With function mappings, you can use only [ INVOKER | DEFINER ] TRUSTED, not system-wide authorization.\nIf an AWS IAM credential provides access, you can omit the AUTHORIZATION clause.",
+      "description": "Specifies the authorization for accessing the external storage. On any platform, you can specify an authorization object ([DatabaseName.]AuthorizationObjectName). You must have the EXECUTE privilege on AuthorizationObjectName.\nOn Amazon S3 and Azure Blob storage and Azure Data Lake Storage Gen2, you can specify either an authorization object or a string in JSON format. The string specifies the USER (identification) and PASSWORD (secret_key) for accessing external storage. The following table shows the supported credentials for USER and PASSWORD (used in the CREATE AUTHORIZATION command):\nSystem/Scheme                       |USER                           |PASSWORD\nAWS                                 |Access Key ID                  |Access Key Secret\nAzure / Shared Key                  |Storage Account Name           |Storage Account Key\nAzure Shared Access Signature (SAS) |Storage Account Name           |Account SAS Token\nGoogle Cloud (S3 interop mode)      |Access Key ID                  |Access Key Secret\nGoogle Cloud (native)               |Client Email                   |Private Key\nOn-premises object stores           |Access Key ID                  |Access Key Secret\nPublic access object stores         |<empty string>                 |<empty string>\n                                    |Enclose the empty string in    |Enclose the empty string in\n                                    |single straight quotes: USER ''| single straight quotes: PASSWORD ''\nIf you use a function mapping to define a wrapper for READ_NOS, you can specify the authorization in the function mapping. With function mappings, you can use only [ INVOKER | DEFINER ] TRUSTED, not system-wide authorization.\nIf an AWS IAM credential provides access, you can omit the AUTHORIZATION clause.",
+      "datatype": ["STRING", "JSON"],
+      "allowsLists": false,
+      "rName": "authorization",
+      "useInR": true,
+      "rOrderNum": 3
+    },
+    {
+      "permittedValues": ["PARQUET", "CSV"],
+      "rDefaultValue": "PARQUET",
+      "isOutputColumn": false,
+      "name": "STOREDAS",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies the formatting style of the external data.\nPARQUET means the external data is formatted as Parquet. Objects created in external storage by write_nos are written only in Parquet format.",
+      "description": "Specifies the formatting style of the external data.\nPARQUET means the external data is formatted as Parquet. Objects created in external storage by write_nos are written only in Parquet format.",
+      "datatype": "STRING",
+      "allowsLists": false,
+      "rName": "stored.as",
+      "useInR": true,
+      "rOrderNum": 4
+    },
+    {
+      "permittedValues": ["DISCRETE", "RANGE"],
+      "defaultValue": "RANGE",
+      "isOutputColumn": false,
+      "name": "NAMING",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies the how the objects containing the rows of data are named in the external storage:\nDiscrete naming uses the ordering column values as part of the object names in external storage. For example, if the PARTITION BY clause has ORDER BY dateColumn, intColumn, the discrete form name of the objects written to external storage would include the values for those columns as part of the object name, which would look similar to this:\nS3/ceph-s3.teradata.com/xz186000/2019-03-01/13/object_33_0_1.parquet\n2019-03-01 is the value for dateColumn, the first ordering column, and 13 is the value for the second ordering column, intColumn. All rows stored in this external Parquet-formatted object contain those two values.\nRange naming, the default, includes as part of the object name the range of values included in the partition for each ordering column. For example, using the same ORDER BY as above the object names would look similar to this:\nS3/ceph-s3.teradata.com/xz186000/2019-01-01/2019-03-02/9/10000/object_33_0_1.parquet\nwhere 2019-01-01 is the minimum value in that object for the first ordering column, dateColumn, 2019-03-02 is the maximum value for the rows stored in this external Parquet-formatted object. Value 9 is the minimum value for the second ordering column, intColumn, and 10000 is the maximum value for that column.",
+      "description": "Specifies the how the objects containing the rows of data are named in the external storage:\nDiscrete naming uses the ordering column values as part of the object names in external storage. For example, if the PARTITION BY clause has ORDER BY dateColumn, intColumn, the discrete form name of the objects written to external storage would include the values for those columns as part of the object name, which would look similar to this:\nS3/ceph-s3.teradata.com/xz186000/2019-03-01/13/object_33_0_1.parquet\n2019-03-01 is the value for dateColumn, the first ordering column, and 13 is the value for the second ordering column, intColumn. All rows stored in this external Parquet-formatted object contain those two values.\nRange naming, the default, includes as part of the object name the range of values included in the partition for each ordering column. For example, using the same ORDER BY as above the object names would look similar to this:\nS3/ceph-s3.teradata.com/xz186000/2019-01-01/2019-03-02/9/10000/object_33_0_1.parquet\nwhere 2019-01-01 is the minimum value in that object for the first ordering column, dateColumn, 2019-03-02 is the maximum value for the rows stored in this external Parquet-formatted object. Value 9 is the minimum value for the second ordering column, intColumn, and 10000 is the maximum value for that column.",
+      "datatype": "STRING",
+      "allowsLists": false,
+      "rName": "naming",
+      "useInR": true,
+      "rOrderNum": 5
+    },
+    {
+      "permittedValues": [],
+      "defaultValue": true,
+      "isOutputColumn": false,
+      "name": "HEADER",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies wheather the first record is to contain the column names.",
+      "description": "Specifies whether the first record is to contain the column names.",
+      "datatype": "BOOLEAN",
+      "allowsLists": false,
+      "rName": "header",
+      "useInR": true,
+      "rOrderNum": 7
+    },
+    {
+      "permittedValues": [],
+      "isOutputColumn": false,
+      "name": "ROWFORMAT",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies the encoding format for the rows in the file type specified in \"stored_as\".",
+      "description": "Specifies the encoding format for the rows in the file type specified in \"stored_as\".",
+      "datatype": ["STRING", "JSON"],
+      "allowsLists": false,
+      "rName": "row.format",
+      "useInR": true,
+      "rOrderNum": 6
+    },
+    {
+      "permittedValues": [],
+      "isOutputColumn": false,
+      "name": "MANIFESTFILE",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies the fully qualified path and file name where the manifest file is written. Use the format\n/connector/end point/bucket_or_container/prefix/manifest_file_name\nFor example:\n/S3/ceph-s3.teradata.com/xz186000/manifest/manifest.json\nIf you do not include the manifestfile parameter, no manifest file is written.",
+      "description": "Specifies the fully qualified path and file name where the manifest file is written. Use the format\n/connector/end point/bucket_or_container/prefix/manifest_file_name\nFor example:\n/S3/ceph-s3.teradata.com/xz186000/manifest/manifest.json\nIf you do not include the manifestfile parameter, no manifest file is written.",
+      "datatype": "STRING",
+      "allowsLists": false,
+      "rName": "manifest.file",
+      "useInR": true,
+      "rOrderNum": 6
+    },
+    {
+      "permittedValues": [],
+      "defaultValue": false,
+      "isOutputColumn": false,
+      "name": "MANIFESTONLY",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies wheather to write only a manifest file in external storage or not. No actual data objects are written to external storage if you use manifestonly = True. You must also use the manifest_file option to create a manifest file in external storage. Use this option to create a new manifest file in the event that a write_nos operation fails due to a database abort or restart, or when network connectivity issues interrupt and stop a write_nos operation before all data has been written to external storage. The manifest is created from the table or query result set that is input to write_nos. The input must be a list of storage object names and sizes, with one row per object.\nNote: The input to write_nos with manifestonly can itself incorporate read_nos, similar to this, which uses function mappings for write_nos and read_nos:\n (TODO: Add manually or update json)\nA query like this can be used if a write_nos operation fails before it can create a manifest file. The new manifest file created using read_nos will reflect all data objects currently in the external storage location, and can aid in determining which data objects resulted from the incomplete write_nos operation. For more information, see Teradata Vantage™ - Native Object Store Getting Started Guide, B035-1214.",
+      "description": "Specifies whether to write only a manifest file in external storage or not. No actual data objects are written to external storage if you use manifestonly = True. You must also use the manifest_file option to create a manifest file in external storage. Use this option to create a new manifest file in the event that a write_nos operation fails due to a database abort or restart, or when network connectivity issues interrupt and stop a write_nos operation before all data has been written to external storage. The manifest is created from the table or query result set that is input to write_nos. The input must be a list of storage object names and sizes, with one row per object.\nNote: The input to write_nos with manifestonly can itself incorporate read_nos, similar to this, which uses function mappings for write_nos and read_nos:\n (TODO: Add manually or update json)\nA query like this can be used if a write_nos operation fails before it can create a manifest file. The new manifest file created using read_nos will reflect all data objects currently in the external storage location, and can aid in determining which data objects resulted from the incomplete write_nos operation. For more information, see Teradata Vantage™ - Native Object Store Getting Started Guide, B035-1214.",
+      "datatype": "BOOLEAN",
+      "allowsLists": false,
+      "rName": "manifest.only",
+      "useInR": true,
+      "rOrderNum": 7
+    },
+    {
+      "permittedValues": [],
+      "defaultValue": false,
+      "isOutputColumn": false,
+      "name": "OVERWRITE",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies whether an existing manifest file in external storage will be overwritten with a new manifest file that has the same name. If False, the default, write_nos returns an error if a manifest file exists in external storage that is named identically to the value of manifestfile.\nNote: overwrite must be used with manifest.only = True",
+      "description": "Specifies whether an existing manifest file in external storage will be overwritten with a new manifest file that has the same name. If False, the default, write_nos returns an error if a manifest file exists in external storage that is named identically to the value of manifestfile.\nNote: overwrite must be used with MANIFESTONLY = True",
+      "datatype": "BOOLEAN",
+      "allowsLists": false,
+      "rName": "overwrite",
+      "useInR": true,
+      "rOrderNum": 8
+    },
+    {
+      "permittedValues": [],
+      "isOutputColumn": false,
+      "name": "INCLUDE_ORDERING",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies whether the ORDER BY columns and their values are written to external storage.",
+      "description": "Specifies whether the ORDER BY columns and their values are written to external storage.",
+      "datatype": "BOOLEAN",
+      "allowsLists": false,
+      "rName": "include.ordering",
+      "useInR": true,
+      "rOrderNum": 9
+    },
+    {
+      "permittedValues": [],
+      "isOutputColumn": false,
+      "name": "INCLUDE_HASHBY",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies whether the HASH BY columns and their values are written to external storage.",
+      "description": "Specifies whether the HASH BY columns and their values are written to external storage.",
+      "datatype": "BOOLEAN",
+      "allowsLists": false,
+      "rName": "include.hashby",
+      "useInR": true,
+      "rOrderNum": 10
+    },
+    {
+      "permittedValues": [],
+      "defaultValue": "16MB",
+      "isOutputColumn": false,
+      "name": "MAXOBJECTSIZE",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies the maximum output object size in megabytes, where max.object.size is a number between 4 and 16. The default is the value of the DefaultRowGroupSize field in DBS Control. For more information on DBS Control, see Teradata Vantage™ - Database Utilities , B035-1102.",
+      "description": "Specifies the maximum output object size in megabytes, where MAXOBJECTSIZE is a number between 4 and 16. The default is the value of the DefaultRowGroupSize field in DBS Control. For more information on DBS Control, see Teradata Vantage™ - Database Utilities , B035-1102.",
+      "datatype": "STRING",
+      "allowsLists": false,
+      "rName": "max.object.size",
+      "useInR": true,
+      "rOrderNum": 11
+    },
+    {
+      "permittedValues": ["GZIP", "SNAPPY"],
+      "isOutputColumn": false,
+      "name": "COMPRESSION",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies the compression algorithm used to compress the objects written to external storage.\nNote: For Parquet files the compression occurs inside parts of the parquet file instead of for the entire file, so the file extension on external objects remains .parquet.",
+      "description": "Specifies the compression algorithm used to compress the objects written to external storage.\nNote: For Parquet files the compression occurs inside parts of the parquet file instead of for the entire file, so the file extension on external objects remains .parquet.",
+      "datatype": "STRING",
+      "allowsLists": false,
+      "rName": "compression",
+      "useInR": true,
+      "rOrderNum": 12
+    }
+  ]
+}

teradataml/data/jsons/uaf/17.20/TD_ACF.json

@@ -0,0 +1,132 @@
+{
+      "FuncName": "TD_ACF",
+      "FuncDescriptionShort": "Calculating auto-correlation and auto-covariance of a time series",
+      "FuncDescriptionLong": [
+          "The auto-covariance and auto-correlation function compute how a time series covaries or correlates with itself, when delayed by a particular lag",
+          "Example:For a lag equal to 1, we calculate the covariance or correlation between time series Yt  and time series Yt-1 ",
+          "for lag equal to 2, we calculate the covariance or correlation between time series Yt  and time series Yt-2 "
+      ],
+      "FunctionVersion": "1.0",
+      "FunctionCategory": "Model Preparation and Parameter Estimation",
+      "JSONVersion": "1.0",
+      "FuncRName": "td_ACF",
+      "MaxInputFiles": 1,
+      "Input": [
+              {
+                    "Type": "SERIES",
+                    "Description": "Specifies a series that is one dimensional array passed as an input to the function.",
+                    "LangName": "data",
+                    "Optional": false
+              }
+      ],
+      "Output": [
+              {
+                    "Type": "ART",
+                    "PrimaryLayer": true,
+                    "LayerName": "ARTPRIMARY",
+                    "ResultTableColumnTypes": [
+                      "integer",
+                      "float",
+                      "float",
+                      "float",
+                      "float",
+                      "float"
+                    ],
+                    "Description": [
+                      "Specifies the result in an ART table"
+                    ],
+                    "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+              }
+      ],
+      "IsPlottable": true,
+      "Params": [
+              {
+                    "Name": "MAXLAGS",
+                    "Type": "integer",
+                    "LowerBound": 1,
+                    "LowerBoundType": "INCLUSIVE",
+                    "Optional": true,
+                    "AllowNaN": false,
+                    "Description": [
+                      "Maximum number of lags at which to calculate the autocorrelation/autocovariance.",
+                      "Default is 10*log10(N) where N is the number of observations.",
+                      "Automatically limited to one less than the number of observations in the series.",
+                      "If the numLags value specified by the user exceeds this limit, the user input value is ignored and replaced with the system defined max value."
+                    ],
+                    "LangName": "max_lags"
+              },
+              {
+                    "Name": "FUNC_TYPE",
+                    "Type": "integer",
+                    "Optional": true,
+                    "DefaultValue": 0,
+                    "AllowNaN": false,
+                    "Description": [
+                      "Specifies whether it is a auto-correlation or auto-covariance function.",
+                      "0 means execute the auto-correlation function.  1 means execute the auto-covariance function"
+                    ],
+                    "PermittedValues": [
+                      0,
+                      1
+                    ]
+              },
+              {
+                    "Name": "UNBIASED",
+                    "Type": "integer",
+                    "Optional": true,
+                    "DefaultValue": 0,
+          "PermittedValues": [
+              0,
+              1
+          ],
+                    "AllowNaN": false,
+                    "Description": [
+                      "If 0, then denominator for autocovariance is n-k (Jenkins & Watts formula)",
+                      "otherwise if 1, denominator for autocovariance is n (Box & Jenkins formula). "
+                    ]
+              },
+              {
+                    "Name": "DEMEAN",
+                    "Type": "integer",
+                    "Optional": true,
+                    "DefaultValue": 1,
+          "PermittedValues": [
+              0,
+              1
+          ],
+                    "AllowNaN": false,
+                    "Description": [
+                      "If 1 (default), then subtract the mean x from each element of x, as specified in the formulas for autocorrelation or autocovariance.",
+                      "If 0, then we do NOT do the subtraction on each element before computing the autocorrelation or autocovariance."
+                    ]
+              },
+              {
+                    "Name": "QSTAT",
+                    "Type": "integer",
+                    "Optional": true,
+                    "DefaultValue": 0,
+          "PermittedValues": [
+              0,
+              1
+          ],
+                    "AllowNaN": false,
+                    "Description": [
+                      "1 means provide Ljung-Box q statistic for each autocorrelation coefficient.",
+                      "0 (default) means do not provide.   Requesting a QSTAT results in a QSTATVAL and PVALUE set of result columns being returned."
+                    ]
+              },
+              {
+                    "Name": "ALPHA",
+                    "Type": "double",
+                    "Optional": true,
+                    "AllowNaN": false,
+                    "Description": [
+                      "If a non-zero positive number is given, the confidence intervals for the given level are returned.",
+                      "For example, if alpha=.05 meaning the 95% level , then confidence intervals are returned where the standard deviation is computed according to Bartlett’s formula.",
+                      "Passing in a positive number results in a CONFINT result column being returned"
+                    ]
+              }
+      ],
+      "InputFmt": false,
+      "OutputFmt": false
+}