Class SqlQuerySpec

Namespace

Microsoft.Azure.Documents

Assembly

Microsoft.Azure.Documents.Client.dll

Represents a SQL query in the Azure Cosmos DB service.

[DataContract]
public sealed class SqlQuerySpec

Inheritance

object

SqlQuerySpec

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

TypeCheckFunctionsExtensions.IsArray(object)

TypeCheckFunctionsExtensions.IsBool(object)

TypeCheckFunctionsExtensions.IsDefined(object)

TypeCheckFunctionsExtensions.IsNull(object)

TypeCheckFunctionsExtensions.IsNumber(object)

TypeCheckFunctionsExtensions.IsObject(object)

TypeCheckFunctionsExtensions.IsPrimitive(object)

TypeCheckFunctionsExtensions.IsString(object)

Constructors

SqlQuerySpec()

Initializes a new instance of the SqlQuerySpec class for the Azure Cosmos DB service.

public SqlQuerySpec()

Remarks

The default constructor initializes any fields to their default values.

SqlQuerySpec(string)

Initializes a new instance of the SqlQuerySpec class for the Azure Cosmos DB service.

public SqlQuerySpec(string queryText)

Parameters

queryText string

The text of the query.

SqlQuerySpec(string, SqlParameterCollection)

Initializes a new instance of the SqlQuerySpec class for the Azure Cosmos DB service.

public SqlQuerySpec(string queryText, SqlParameterCollection parameters)

Parameters

queryText string

The text of the database query.

parameters SqlParameterCollection

The SqlParameterCollection instance, which represents the collection of query parameters.

Properties

Parameters

Gets or sets the SqlParameterCollection instance, which represents the collection of Azure Cosmos DB query parameters.

[DataMember(Name = "parameters")]
public SqlParameterCollection Parameters { get; set; }

Property Value

SqlParameterCollection

The SqlParameterCollection instance.

QueryText

Gets or sets the text of the Azure Cosmos DB database query.

[DataMember(Name = "query")]
public string QueryText { get; set; }

Property Value

string

The text of the database query.

Methods

ShouldSerializeParameters()

Returns a value that indicates whether the Azure Cosmos DB database Parameters property should be serialized.

public bool ShouldSerializeParameters()

Returns

bool