GenerateMergedTable Overview: JOIN-Based Wide Table Queries - OpenSearch - Alibaba Cloud - OpenSearch

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

opensearch:GenerateMergedTable

get

*All Resource

*

None

Request syntax

POST /v4/openapi/assist/schema/actions/merge HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
spec	string	No	The specifications of the OpenSearch instance, used to verify whether the instance meets the special limits on an exclusive instance. Default value: opensearch.share.common. For more information, see the description of the spec field in the Quota topic.	"opensearch.share.common"
body	Schema	No	The request body parameters.

Request body

Parameter	Type	Required	Example	Description
tables	Object	Yes		The table schema.
indexes	Object	No		The index schema.

Response elements

Element	Type	Description	Example
	object
requestId	string	The request ID.	ABCDEFGH
result	object	The response parameters.
primaryKey	string	The primary key.	-
mergeTable	object	The wide table generated by joining multiple tables.	-
fromTable	object	The source tables used in the JOIN operation.	-

Response parameters

Parameter	Type	Description
requestId	String	The request ID.
result.mergeTable	Object	The wide table generated by joining multiple tables. The key is the field name and the value is the field content.
result.fromTable	Object	The source tables used in the JOIN operation.
result.fromTable.tables	Object	The table details. The key is the table name and the value is the table schema.
result.fromTable.tables.*	Object	The key is the field name and the value is the field content.
result.fromTable.master	String	The primary table.
result.fromTable.level	Object	The table levels, starting from 0. The key is the table name and the value is the table level.
result.fromTable.joinMap	Object	The external table mapping. The key is the table name and the value is the external table details.
result.fromTable.joinMap.*	Object	The fields of the external table. The key is the field name and the value is the field content.
result.primaryKey	String	The primary key field.

TableFields

Parameter	Type	Description
name	String	The name of the field.
type	String	The type of the field. For more information, see Fields in a data table.
isPk	String	Indicates whether the field is the primary key field. Valid values:0: The field is not the primary key field.1: The field is the primary key field.
isMulti	Integer	Indicates whether the field is a multi-value field. Valid values:0: The field is not a multi-value field.1: The field is a multi-value field.
isAttribute	Integer	Indicates whether the field is an attribute field. Valid values:0: The field is not an attribute field.1: The field is an attribute field.

JoinMapFields

Parameter	Type	Description
table	String	The name of the external table.
key	String	The name of the primary key of the external table.
join	Object	The extended fields of the external table.

Examples

Success response

JSON format

{
  "requestId": "ABCDEFGH",
  "result": {
    "primaryKey": "-",
    "mergeTable": {
      "test": "test",
      "test2": 1
    },
    "fromTable": {
      "test": "test",
      "test2": 1
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.