Class LowLevelSqlNamespace

Sql APIs.

Not intended to be instantiated directly. Use the Sql property on IOpenSearchLowLevelClient.

Inheritance

object

NamespacedClientProxy

LowLevelSqlNamespace

Inherited Members

NamespacedClientProxy.DoRequest<TResponse>(HttpMethod, string, PostData, IRequestParameters)

NamespacedClientProxy.DoRequestAsync<TResponse>(HttpMethod, string, CancellationToken, PostData, IRequestParameters)

NamespacedClientProxy.Url(FormattableString)

NamespacedClientProxy.RequestParams<TRequestParams>(TRequestParams, string)

NamespacedClientProxy.RequestParams<TRequestParams>(TRequestParams)

NamespacedClientProxy.ContentType

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Net.Specification.SqlApi

Assembly: OpenSearch.Net.dll

Syntax

public class LowLevelSqlNamespace : NamespacedClientProxy

Methods

CloseAsync<TResponse>(PostData, CloseRequestParameters, CancellationToken)

POST on /_plugins/_sql/close

https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/

Declaration

public Task<TResponse> CloseAsync<TResponse>(PostData body, CloseRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	Contains the cursor identifier to close.
CloseRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Close<TResponse>(PostData, CloseRequestParameters)

POST on /_plugins/_sql/close

https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/

Declaration

public TResponse Close<TResponse>(PostData body, CloseRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	Contains the cursor identifier to close.
CloseRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

ExplainAsync<TResponse>(PostData, ExplainRequestParameters, CancellationToken)

POST on /_plugins/_sql/_explain

https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/

Declaration

public Task<TResponse> ExplainAsync<TResponse>(PostData body, ExplainRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	Contains the SQL or PPL query to explain.
ExplainRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Explain<TResponse>(PostData, ExplainRequestParameters)

POST on /_plugins/_sql/_explain

https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/

Declaration

public TResponse Explain<TResponse>(PostData body, ExplainRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	Contains the SQL or PPL query to explain.
ExplainRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

GetStatsAsync<TResponse>(GetStatsRequestParameters, CancellationToken)

GET on /_plugins/_sql/stats

https://opensearch.org/docs/latest/search-plugins/sql/monitoring/

Declaration

public Task<TResponse> GetStatsAsync<TResponse>(GetStatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetStatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

GetStats<TResponse>(GetStatsRequestParameters)

GET on /_plugins/_sql/stats

https://opensearch.org/docs/latest/search-plugins/sql/monitoring/

Declaration

public TResponse GetStats<TResponse>(GetStatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetStatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

PostStatsAsync<TResponse>(PostData, PostStatsRequestParameters, CancellationToken)

POST on /_plugins/_sql/stats

https://opensearch.org/docs/latest/search-plugins/sql/monitoring/

Declaration

public Task<TResponse> PostStatsAsync<TResponse>(PostData body, PostStatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	Defines the statistics collection parameters.
PostStatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

PostStats<TResponse>(PostData, PostStatsRequestParameters)

POST on /_plugins/_sql/stats

https://opensearch.org/docs/latest/search-plugins/sql/monitoring/

Declaration

public TResponse PostStats<TResponse>(PostData body, PostStatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	Defines the statistics collection parameters.
PostStatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

QueryAsync<TResponse>(PostData, QueryRequestParameters, CancellationToken)

POST on /_plugins/_sql

https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/

Declaration

public Task<TResponse> QueryAsync<TResponse>(PostData body, QueryRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	Contains the SQL or PPL query to execute.
QueryRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Query<TResponse>(PostData, QueryRequestParameters)

POST on /_plugins/_sql

https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/

Declaration

public TResponse Query<TResponse>(PostData body, QueryRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	Contains the SQL or PPL query to execute.
QueryRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

SettingsAsync<TResponse>(PostData, SettingsRequestParameters, CancellationToken)

PUT on /_plugins/_query/settings

https://opensearch.org/docs/latest/search-plugins/sql/settings/

Declaration

public Task<TResponse> SettingsAsync<TResponse>(PostData body, SettingsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	Contains SQL plugin configuration settings.
SettingsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Settings<TResponse>(PostData, SettingsRequestParameters)

PUT on /_plugins/_query/settings

https://opensearch.org/docs/latest/search-plugins/sql/settings/

Declaration

public TResponse Settings<TResponse>(PostData body, SettingsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	Contains SQL plugin configuration settings.
SettingsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Extension Methods

SuffixExtensions.Suffix(object, string)