ecms_database

Property Manager name: Message Store database selection
Behavior version: The v2023-01-05 rule format supports the ecms_database behavior v1.0.
Rule format status: GA, stable
Access: Read/Write
Allowed in includes: No (temporarily)

Edge Connect Message Store is available for Internet of Things: Edge Connect users. It lets you create databases and data sets within these databases. You can use this object store to save files smaller than 2 GB. ecmsDatabase specifies a default database for requests to this property, unless indicated otherwise in the URL. To access objects in the default database, you can skip its name in the URLs. To access objects in a different database, pass its name in the header, query parameter, or a regular expression matching a URL segment. You can also configure the ecms_dataset behavior to specify a default data set for requests.

Option	Type	Description	Requires
`database`	string	Specifies a default database for this property. If you don't configure a default data set in the `ecms_dataset` behavior, requests to objects in this database follow the pattern: `<hostname>/datastore/<data_set_name>/<object_key>`.		{"displayType":"string","tag":"input","type":"text"}
`extract_location`	enum	Specifies where to pass a database name in requests. If the specified location doesn't include the database name or the name doesn't match the regular expression, the default database is used.		{"displayType":"enum","options":["CLIENT_REQUEST_HEADER","QUERY_STRING","REGEX"],"tag":"select"}
	`CLIENT_REQUEST_HEADER`	Name is a request header.
	`QUERY_STRING`	Name is a query parameter.
	`REGEX`	Name matches the URL.
`header_name`	string	Specifies the request header that passed the database name. By default, it points to `X-KV-Database`.	`extract_location` is `CLIENT_REQUEST_HEADER`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"extractLocation","op":"eq","value":"CLIENT_REQUEST_HEADER"}}
`query_parameter_name`	string	Specifies the query string parameter that passed the database name. By default, it points to `database`.	`extract_location` is `QUERY_STRING`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"extractLocation","op":"eq","value":"QUERY_STRING"}}
`regex_pattern`	string	Specifies the regular expression that matches the database name in the URL.	`extract_location` is `REGEX`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"extractLocation","op":"eq","value":"REGEX"}}