Class SqlRequestBuilder

Builds and executes requests for operations under \docs{docId}\sql

Inheritance

object

BaseRequestBuilder

SqlRequestBuilder

Inherited Members

BaseRequestBuilder.PathParameters

BaseRequestBuilder.RequestAdapter

BaseRequestBuilder.UrlTemplate

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Grist4NET.Kiota.Docs.Item.Sql

Assembly: Grist4NET.Kiota.dll

Syntax

public class SqlRequestBuilder : BaseRequestBuilder

Constructors

SqlRequestBuilder(Dictionary<string, object>, IRequestAdapter)

Instantiates a new SqlRequestBuilder and sets the default values.

Declaration

public SqlRequestBuilder(Dictionary<string, object> pathParameters, IRequestAdapter requestAdapter)

Parameters

Type	Name	Description
Dictionary<string, object>	pathParameters	Path parameters for the request
IRequestAdapter	requestAdapter	The request adapter to use to execute the requests.

SqlRequestBuilder(string, IRequestAdapter)

Instantiates a new SqlRequestBuilder and sets the default values.

Declaration

public SqlRequestBuilder(string rawUrl, IRequestAdapter requestAdapter)

Parameters

Type	Name	Description
string	rawUrl	The raw URL to use for the request builder.
IRequestAdapter	requestAdapter	The request adapter to use to execute the requests.

Methods

GetAsync(Action<RequestConfiguration<SqlRequestBuilderGetQueryParameters>>, CancellationToken)

Execute a read-only SQL SELECT query against the document's SQLite database.This is a simplified endpoint for basic queries. For queries with parametersor custom timeouts, use the POST endpoint instead.

Declaration

public Task<SqlResultSet> GetAsync(Action<RequestConfiguration<SqlRequestBuilder.SqlRequestBuilderGetQueryParameters>> requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Action<RequestConfiguration<SqlRequestBuilder.SqlRequestBuilderGetQueryParameters>>	requestConfiguration	Configuration for the request such as headers, query parameters, and middleware options.
CancellationToken	cancellationToken	Cancellation token to use when cancelling requests

Returns

Type	Description
Task<SqlResultSet>	A SqlResultSet

PostAsync(SqlPostRequestBody, Action<RequestConfiguration<DefaultQueryParameters>>, CancellationToken)

Execute a read-only SQL SELECT query with support for parameterized queriesand custom timeouts. All Grist documents are SQLite databases, and queriesare executed directly against SQLite with security restrictions.

Declaration

public Task<SqlResultSet> PostAsync(SqlPostRequestBody body, Action<RequestConfiguration<DefaultQueryParameters>> requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
SqlPostRequestBody	body	The request body
Action<RequestConfiguration<DefaultQueryParameters>>	requestConfiguration	Configuration for the request such as headers, query parameters, and middleware options.
CancellationToken	cancellationToken	Cancellation token to use when cancelling requests

Returns

Type	Description
Task<SqlResultSet>	A SqlResultSet

ToGetRequestInformation(Action<RequestConfiguration<SqlRequestBuilderGetQueryParameters>>)

Execute a read-only SQL SELECT query against the document's SQLite database.This is a simplified endpoint for basic queries. For queries with parametersor custom timeouts, use the POST endpoint instead.

Declaration

public RequestInformation ToGetRequestInformation(Action<RequestConfiguration<SqlRequestBuilder.SqlRequestBuilderGetQueryParameters>> requestConfiguration = null)

Parameters

Type	Name	Description
Action<RequestConfiguration<SqlRequestBuilder.SqlRequestBuilderGetQueryParameters>>	requestConfiguration	Configuration for the request such as headers, query parameters, and middleware options.

Returns

Type	Description
RequestInformation	A Microsoft.Kiota.Abstractions.RequestInformation

ToPostRequestInformation(SqlPostRequestBody, Action<RequestConfiguration<DefaultQueryParameters>>)

Execute a read-only SQL SELECT query with support for parameterized queriesand custom timeouts. All Grist documents are SQLite databases, and queriesare executed directly against SQLite with security restrictions.

Declaration

public RequestInformation ToPostRequestInformation(SqlPostRequestBody body, Action<RequestConfiguration<DefaultQueryParameters>> requestConfiguration = null)

Parameters

Type	Name	Description
SqlPostRequestBody	body	The request body
Action<RequestConfiguration<DefaultQueryParameters>>	requestConfiguration	Configuration for the request such as headers, query parameters, and middleware options.

Returns

Type	Description
RequestInformation	A Microsoft.Kiota.Abstractions.RequestInformation

WithUrl(string)

Returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored.

Declaration

public SqlRequestBuilder WithUrl(string rawUrl)

Parameters

Type	Name	Description
string	rawUrl	The raw URL to use for the request builder.

Returns

Type	Description
SqlRequestBuilder	A SqlRequestBuilder