Add a new Data Registry entry
POST {{baseUrl}}/dataRegistries
Initiate creation of Data Registry for the current tenant.
The Data Registry information is used during data ingest for the tenant. Only one Data Registry can be created for a request. The sourceName, dataTag and fileUploadStrategy is required to create Date Registry otherwise creation is rejected. DataUpload will allow only files to be uploaded matching this Data Registry. This returns unique registryId for each request that can be used to retrieve the created registry.
SDI provides an option to the user to skip the schema discovery by setting the 'schemaFrozen' flag to true. This feature is useful in cases when large number of files are ingested in SDI and the schema doesn't change with each file ingestion. The schemaFrozen flag must be set to false during creation of a registry. It can be set to true after creation of the initial schema for the registry.
Data partitioning on the registry can be optionally enabled by specifying a single partitionKey at the time of registry creation. The property value can be set to sdi-default-partition-key
to enable default partitioning based on the sdi_hour attribute. The property can also be set to a custom attribute present in the data to enable custom partitioning based on that attribute.
While creating the registry, user can optionally specify IDL source folder location(s) in the registrySourcePaths array (at present, only a single registrySourcePath can be specified).
SDI supports a mode in which the query is performed by directly reading the user files in the IDL. To use this mode, user can set the 'convertSourceFilesToParquet' flag to false and specify a registrySourcePath at the time of registry creation.
Request Body
{"dataTag"=>"<string>", "defaultRootTag"=>"<string>", "filePattern"=>"<string>", "fileUploadStrategy"=>"<string>", "metaDataTags"=>["<string>", "<string>"], "sourceName"=>"<string>", "xmlProcessRules"=>["<string>", "<string>"], "partitionKeys"=>["<string>", "<string>"], "schemaFrozen"=>false, "convertSourceFilesToParquet"=>true, "registrySourcePaths"=>["<string>", "<string>"]}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: Created
{"createdDate":"laborum sed in","dataTag":"eiusmod ad","defaultRootTag":"ex adipisicing nostrud","filePattern":"consequat nulla anim","fileUploadStrategy":"replace","updatedDate":"occaecat magna amet cillum nostrud","metaDataTags":["laboris do ut esse exercitation","officia velit aliquip"],"xmlProcessRules":["consequat","ad aliqua"],"partitionKeys":["","veniam pariatur"],"mutable":false,"registryId":"quis nulla","sourceId":"dolor velit","sourceName":"dolor","schemaFrozen":false,"convertSourceFilesToParquet":true,"registrySourcePaths":["non ","culpa"]}