teradataml 20.0.0.8__py3-none-any.whl

teradataml/data/jsons/storedprocedure/17.20/TD_FILTERFACTORY1D.json

@@ -0,0 +1,150 @@
+{
+        "FuncName": "TD_FILTERFACTORY1D",
+        "FuncDescriptionShort": "TD_FILTERFACTORYID creates finite impulse response (FIR) filter coefficients.",
+        "FuncDescriptionLong": [
+                "The filters are based on certain parameters and stored into a common table for reuse."
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "General Utility",
+        "JSONVersion": "1",
+        "FuncRName": "td_Filter_Factory1d",
+        "MaxInputFiles": 0,
+		"Input": [],
+        "Params":[
+                {
+                        "Name": "FILTERID",
+                        "Type": "integer",
+                        "Optional": false,
+                        "Description": [
+                                "Filter identifier, based on filter coefficients, stored in the table."
+                        ],
+                        "LangName": "filter_id"
+                },
+                {
+                        "Name": "FILTERTYPE",
+                        "Type": "string",
+                        "Optional": false,
+                        "PermittedValues": [
+                                "LOWPASS",
+                                "HIGHPASS",
+                                "BANDPASS",
+                                "BANDSTOP"
+                        ],
+                        "Description": [
+                                "The type of filter to generate.",
+                                "Options are:",
+                                "LOWPASS to remove frequencies above LOWCUTOFF.",
+                                "HIGHPASS to remove frequencies below HIGHCUTOFF.",
+                                "BANDPASS to remove frequencies below LOWCUTOFF and above HIGHCUTOFF.",
+                                "BANDSTOP to remove frequencies between LOWCUTOFF and HIGHCUTOFF."
+                        ],
+                        "LangName": "filter_type"
+                },
+                {
+                        "Name": "WINDOWTYPE",
+                        "Type": "string",
+                        "Optional": true,
+                        "PermittedValues": [
+                                "BLACKMAN",
+                                "HAMMING",
+                                "HANNING",
+                                "BARTLETT"
+                        ],
+                        "Description": [
+                                "[Optional] Window function to the filter that maintains a smooth drop off to zero, and avoids extra artifacts in the frequency domain.",
+                                "Window is applied by multiplying W(n) to the n-th coefficient of the filter",
+                                "Default is to not apply any windowing function to the filter (leave the filter coefficients as they are)",
+                                "Options are:",
+                                "BLACKMAN [ W(n) = 0.42 - 1/2*COS(2PI*n/N) + 0.08*COS(4PI * n/N) ]",
+                                "HAMMING [ W(n) = 0.54 - 0.46 * COS(2PI*n/N) ]",
+                                "HANNING [ W(n) = 0.5 - 0.5 * COS(2PI*n/N) ]",
+                                "BARTLETT [ W(n) = ",
+                                "{",
+                                "        (2 * n/N)    , for n <  N/2",
+                                "        (2 - 2 * n/N), for n >= N/2",
+                                "} ]"
+                        ],
+                        "LangName": "window_type"
+                },
+                {
+                        "Name": "FILTERLENGTH",
+                        "Type": "integer",
+                        "Optional": true,
+                        "Description": [
+                                "[Optional] Length of the filter to generate.",
+                                "Overrides TRANSITIONBANDWIDTH argument if both are supplied, and renders the other an optional argument.",
+                                "Default is approximately 4/(TRANSITIONBANDWIDTH/ SAMPLINGFREQUENCY)."
+                        ],
+                        "LangName": "filter_length"
+                },
+                {
+                        "Name": "TRANSITIONBANDWIDTH",
+                        "Type": "double",
+                        "Optional": true,
+                        "LowerBound": 0,
+                        "LowerBoundType": "EXCLUSIVE",
+                        "Description": [
+                                "[Optional] The maximum allowed size for the range of frequencies for filter transitions between a passband and stopband.",
+                                "This also determines the number of coefficients to be generated.",
+                                "Value must be greater than 0.",
+                                "A smaller value produces faster drop off at the cost of more coefficients.",
+                                "Not used when FILTERLENGTH is supplied.",
+                                "Default is bandwidth from FILTERLENGTH."
+                        ],
+                        "LangName": "transition_bandwidth"
+                },
+                {
+                        "Name": "LOWCUTOFF",
+                        "Type": "double",
+                        "Optional": true,
+                        "LowerBound": 0,
+                        "LowerBoundType": "EXCLUSIVE",
+                        "Description": [
+                                "[Optional] Determines the lower frequency that change between a passband and stopband occurs.",
+                                "Must be greater than 0.",
+                                "Not used by default with HIGHPASS filter."
+                        ],
+                        "LangName": "low_cutoff"
+                },
+                {
+                        "Name": "HIGHCUTOFF",
+                        "Type": "double",
+                        "Optional": true,
+                        "LowerBound": 0,
+                        "LowerBoundType": "EXCLUSIVE",
+                        "Description": [
+                                "[Optional] Determines the higher frequency that change between a passband and stopband occurs.",
+                                "Must be greater than 0.",
+                                "Not used by default with LOWPASS filter."
+                        ],
+                        "LangName": "high_cutoff"
+                },
+                {
+                        "Name": "SAMPLINGFREQUENCY",
+                        "Type": "double",
+                        "Optional": false,
+                        "LowerBound": 0,
+                        "LowerBoundType": "EXCLUSIVE",
+                        "Description": [
+                                "The frequency that the data to be filtered was sampled.",
+                                "Must be greater than 0."
+                        ],
+                        "LangName": "sampling_frequency"
+                },
+                {
+                        "Name": "FILTERDESCRIPTION",
+                        "Type": "string",
+                        "Optional": true,
+                        "Description": [
+                                "[Optional] Description for the filter coefficients that contain the same filter ID.",
+                                "Description is only written to one row for each filter generated, and ROW_I is 0.",
+                                "Default is a string describing parameters."
+                        ],
+                        "LangName": "filter_description"
+                }
+        ],
+        "Output": [],
+        "IsPlottable": true,
+        "InputFmt": false,
+        "OutputFmt": false
+}

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

@@ -0,0 +1,198 @@
+{
+  "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": [],
+      "defaultValue": 16,
+      "isOutputColumn": false,
+      "name": "BUFFERSIZE",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies the size of the network buffer to allocate when retrieving data from the external storage repository. The default value is 16 MB, which is the maximum value",
+      "description": "Specifies the size of the network buffer to allocate when retrieving data from the external storage repository. The default value is 16 MB, which is the maximum value",
+      "datatype": "INTEGER",
+      "allowsLists": false,
+      "rName": "buffer.size",
+      "useInR": true,
+      "rOrderNum": 3
+    },
+    {
+      "permittedValues": ["NOSREAD_RECORD", "NOSREAD_KEYS", "NOSREAD_RAW", "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.\nNOSREAD_RAW: Retrieves file data from the external storage services, not specific records. Retrieved data is returned as CLOB/BLOB. You can retrieve a complete file from external storage and save in Teradata CLOB/BLOB format. The maximum amount of data that can be retrieved from the external storage and saved in the Teradata column is 2GB, the Vantage limit for LOBs. The ObjectLength corresponds to the length of CLOB/BLOB column read from the external storage. This information is provided in the form of a table returned to the READ_NOS table operator. The Payload column in the input table is only used to determine the datatype of the column in which the returned data is stored.\nDefine the input table with the following columns: Location VARCHAR(2048) CHARACTER SET UNICODE, Location VARCHAR(2048) CHARACTER SET UNICODE, ObjectTimeStamp TIMESTAMP(6), ObjectTimeStamp TIMESTAMP(6), ObjectTimeStamp TIMESTAMP(6), Payload CLOB/BLOB.\nREAD_NOS returns a table with the following columns: Location VARCHAR(2048) CHARACTER SET UNICODE, ObjectVersionID VARCHAR(1024) CHARACTER SET UNICODE, ObjectTimeStamp TIMESTAMP(6), OffsetIntoObject BIGINT, OffsetIntoObject BIGINT, Payload CLOB/BLOB, based on input table CLOB/BLOB Column.\nNOSREAD_PARQUET_SCHEMA: Returns information about the Parquet data schema. For information about the mapping between Parquet data types and Teradata data types, see Parquet External Files in Teradata Vantage™ - SQL Data Definition Language Syntax and Examples, B035-1144.",
+      "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.\nNOSREAD_RAW: Retrieves file data from the external storage services, not specific records. Retrieved data is returned as CLOB/BLOB. You can retrieve a complete file from external storage and save in Teradata CLOB/BLOB format. The maximum amount of data that can be retrieved from the external storage and saved in the Teradata column is 2GB, the Vantage limit for LOBs. The ObjectLength corresponds to the length of CLOB/BLOB column read from the external storage. This information is provided in the form of a table returned to the READ_NOS table operator. The Payload column in the input table is only used to determine the datatype of the column in which the returned data is stored.\nDefine the input table with the following columns: Location VARCHAR(2048) CHARACTER SET UNICODE, Location VARCHAR(2048) CHARACTER SET UNICODE, ObjectTimeStamp TIMESTAMP(6), ObjectTimeStamp TIMESTAMP(6), ObjectTimeStamp TIMESTAMP(6), Payload CLOB/BLOB.\nREAD_NOS returns a table with the following columns: Location VARCHAR(2048) CHARACTER SET UNICODE, ObjectVersionID VARCHAR(1024) CHARACTER SET UNICODE, ObjectTimeStamp TIMESTAMP(6), OffsetIntoObject BIGINT, OffsetIntoObject BIGINT, Payload CLOB/BLOB, based on input table CLOB/BLOB Column.\nNOSREAD_PARQUET_SCHEMA: Returns information about the Parquet data schema. For information about the mapping between Parquet data types and Teradata data types, see Parquet External Files in Teradata Vantage™ - SQL Data Definition Language Syntax and Examples, B035-1144.", 
+      "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": [],
+      "defaultValue": false,
+      "isOutputColumn": false,
+      "name": "FULLSCAN",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies whether read.nos scans columns of variable length types (CHAR, VARCHAR, BYTE, VARBYTE, JSON, and BSON) to discover the maximum length.\nWhen set to True, the sizes of variable length data is determined from the Parquet data.\nNote: Choosing this value can impact performance because all variable length data type columns in each Parquet file at the location must be scanned to assess the value having the greatest length.\nWhen set to False, variable length field sizes are assigned the Vantage maximum value for the particular data type. The default is False.",
+      "description": "Determines whether READ_NOS scans columns of variable length types (CHAR, VARCHAR, BYTE, VARBYTE, JSON, and BSON) to discover the maximum length.\nWhen set to True, the sizes of variable length data is determined from the Parquet data.\nNote: Choosing this value can impact performance because all variable length data type columns in each Parquet file at the location must be scanned to assess the value having the greatest length.\nWhen set to False, variable length field sizes are assigned the Vantage maximum value for the particular data type. The default is False.",
+      "datatype": "BOOLEAN",
+      "allowsLists": false,
+      "rName": "full.scan",
+      "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": [],
+      "isOutputColumn": false,
+      "name": "ACCESS_ID",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies the identification to access external storage. Specifying this option is not necessary if an authentication is defined, for example, in the EXTERNAL SECURITY clause of a function mapping or if IAM roles are defined for S3 repositories. See CREATE FUNCTION MAPPING in Teradata Vantage™ - SQL Data Definition Language Syntax and Examples, B035-1144.",
+      "description": "Identification to access external storage. Specifying this option is not necessary if an authentication is defined, for example, in the EXTERNAL SECURITY clause of a function mapping or if IAM roles are defined for S3 repositories. See CREATE FUNCTION MAPPING in Teradata Vantage™ - SQL Data Definition Language Syntax and Examples, B035-1144.",
+      "datatype": "STRING",
+      "allowsLists": false,
+      "rName": "access.id",
+      "useInR": true,
+      "rOrderNum": 9
+    },
+    {
+      "permittedValues": [],
+      "isOutputColumn": false,
+      "name": "ACCESS_KEY",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies the password to access external storage. Specifying this option is not necessary if an authentication is defined, for example, in the EXTERNAL SECURITY clause of a function mapping or if IAM roles are defined for S3 repositories. See CREATE FUNCTION MAPPING in Teradata Vantage™ - SQL Data Definition Language Syntax and Examples, B035-1144.",
+      "description": "Password to access external storage. Specifying this option is not necessary if an authentication is defined, for example, in the EXTERNAL SECURITY clause of a function mapping or if IAM roles are defined for S3 repositories. See CREATE FUNCTION MAPPING in Teradata Vantage™ - SQL Data Definition Language Syntax and Examples, B035-1144.",
+      "datatype": "STRING",
+      "allowsLists": false,
+      "rName": "access.key",
+      "useInR": true,
+      "rOrderNum": 10
+    },
+    {
+      "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": 11
+    },
+    {
+      "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": 12
+    }
+  ]
+}

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

@@ -0,0 +1,198 @@
+{
+  "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": [],
+      "defaultValue": 16,
+      "isOutputColumn": false,
+      "name": "BUFFERSIZE",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies the size of the network buffer to allocate when retrieving data from the external storage repository. The default value is 16 MB, which is the maximum value",
+      "description": "Specifies the size of the network buffer to allocate when retrieving data from the external storage repository. The default value is 16 MB, which is the maximum value",
+      "datatype": "INTEGER",
+      "allowsLists": false,
+      "rName": "buffer.size",
+      "useInR": true,
+      "rOrderNum": 3
+    },
+    {
+      "permittedValues": ["NOSREAD_RECORD", "NOSREAD_KEYS", "NOSREAD_RAW", "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.\nNOSREAD_RAW: Retrieves file data from the external storage services, not specific records. Retrieved data is returned as CLOB/BLOB. You can retrieve a complete file from external storage and save in Teradata CLOB/BLOB format. The maximum amount of data that can be retrieved from the external storage and saved in the Teradata column is 2GB, the Vantage limit for LOBs. The ObjectLength corresponds to the length of CLOB/BLOB column read from the external storage. This information is provided in the form of a table returned to the READ_NOS table operator. The Payload column in the input table is only used to determine the datatype of the column in which the returned data is stored.\nDefine the input table with the following columns: Location VARCHAR(2048) CHARACTER SET UNICODE, Location VARCHAR(2048) CHARACTER SET UNICODE, ObjectTimeStamp TIMESTAMP(6), ObjectTimeStamp TIMESTAMP(6), ObjectTimeStamp TIMESTAMP(6), Payload CLOB/BLOB.\nREAD_NOS returns a table with the following columns: Location VARCHAR(2048) CHARACTER SET UNICODE, ObjectVersionID VARCHAR(1024) CHARACTER SET UNICODE, ObjectTimeStamp TIMESTAMP(6), OffsetIntoObject BIGINT, OffsetIntoObject BIGINT, Payload CLOB/BLOB, based on input table CLOB/BLOB Column.\nNOSREAD_PARQUET_SCHEMA: Returns information about the Parquet data schema. For information about the mapping between Parquet data types and Teradata data types, see Parquet External Files in Teradata Vantage™ - SQL Data Definition Language Syntax and Examples, B035-1144.",
+      "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.\nNOSREAD_RAW: Retrieves file data from the external storage services, not specific records. Retrieved data is returned as CLOB/BLOB. You can retrieve a complete file from external storage and save in Teradata CLOB/BLOB format. The maximum amount of data that can be retrieved from the external storage and saved in the Teradata column is 2GB, the Vantage limit for LOBs. The ObjectLength corresponds to the length of CLOB/BLOB column read from the external storage. This information is provided in the form of a table returned to the READ_NOS table operator. The Payload column in the input table is only used to determine the datatype of the column in which the returned data is stored.\nDefine the input table with the following columns: Location VARCHAR(2048) CHARACTER SET UNICODE, Location VARCHAR(2048) CHARACTER SET UNICODE, ObjectTimeStamp TIMESTAMP(6), ObjectTimeStamp TIMESTAMP(6), ObjectTimeStamp TIMESTAMP(6), Payload CLOB/BLOB.\nREAD_NOS returns a table with the following columns: Location VARCHAR(2048) CHARACTER SET UNICODE, ObjectVersionID VARCHAR(1024) CHARACTER SET UNICODE, ObjectTimeStamp TIMESTAMP(6), OffsetIntoObject BIGINT, OffsetIntoObject BIGINT, Payload CLOB/BLOB, based on input table CLOB/BLOB Column.\nNOSREAD_PARQUET_SCHEMA: Returns information about the Parquet data schema. For information about the mapping between Parquet data types and Teradata data types, see Parquet External Files in Teradata Vantage™ - SQL Data Definition Language Syntax and Examples, B035-1144.", 
+      "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": [],
+      "defaultValue": false,
+      "isOutputColumn": false,
+      "name": "FULLSCAN",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies whether read.nos scans columns of variable length types (CHAR, VARCHAR, BYTE, VARBYTE, JSON, and BSON) to discover the maximum length.\nWhen set to True, the sizes of variable length data is determined from the Parquet data.\nNote: Choosing this value can impact performance because all variable length data type columns in each Parquet file at the location must be scanned to assess the value having the greatest length.\nWhen set to False, variable length field sizes are assigned the Vantage maximum value for the particular data type. The default is False.",
+      "description": "Determines whether READ_NOS scans columns of variable length types (CHAR, VARCHAR, BYTE, VARBYTE, JSON, and BSON) to discover the maximum length.\nWhen set to True, the sizes of variable length data is determined from the Parquet data.\nNote: Choosing this value can impact performance because all variable length data type columns in each Parquet file at the location must be scanned to assess the value having the greatest length.\nWhen set to False, variable length field sizes are assigned the Vantage maximum value for the particular data type. The default is False.",
+      "datatype": "BOOLEAN",
+      "allowsLists": false,
+      "rName": "full.scan",
+      "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": [],
+      "isOutputColumn": false,
+      "name": "ACCESS_ID",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies the identification to access external storage. Specifying this option is not necessary if an authentication is defined, for example, in the EXTERNAL SECURITY clause of a function mapping or if IAM roles are defined for S3 repositories. See CREATE FUNCTION MAPPING in Teradata Vantage™ - SQL Data Definition Language Syntax and Examples, B035-1144.",
+      "description": "Identification to access external storage. Specifying this option is not necessary if an authentication is defined, for example, in the EXTERNAL SECURITY clause of a function mapping or if IAM roles are defined for S3 repositories. See CREATE FUNCTION MAPPING in Teradata Vantage™ - SQL Data Definition Language Syntax and Examples, B035-1144.",
+      "datatype": "STRING",
+      "allowsLists": false,
+      "rName": "access.id",
+      "useInR": true,
+      "rOrderNum": 9
+    },
+    {
+      "permittedValues": [],
+      "isOutputColumn": false,
+      "name": "ACCESS_KEY",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies the password to access external storage. Specifying this option is not necessary if an authentication is defined, for example, in the EXTERNAL SECURITY clause of a function mapping or if IAM roles are defined for S3 repositories. See CREATE FUNCTION MAPPING in Teradata Vantage™ - SQL Data Definition Language Syntax and Examples, B035-1144.",
+      "description": "Password to access external storage. Specifying this option is not necessary if an authentication is defined, for example, in the EXTERNAL SECURITY clause of a function mapping or if IAM roles are defined for S3 repositories. See CREATE FUNCTION MAPPING in Teradata Vantage™ - SQL Data Definition Language Syntax and Examples, B035-1144.",
+      "datatype": "STRING",
+      "allowsLists": false,
+      "rName": "access.key",
+      "useInR": true,
+      "rOrderNum": 10
+    },
+    {
+      "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": 11
+    },
+    {
+      "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": 12
+    }
+  ]
+}