public sealed class PrepareQueryRequest : IMessage<PrepareQueryRequest>, IEquatable<PrepareQueryRequest>, IDeepCloneable<PrepareQueryRequest>, IBufferMessage, IMessage
Reference documentation and code samples for the Google Bigtable v2 API class PrepareQueryRequest.
Optional. This value specifies routing for preparing the query. Note that
this app_profile_id is only used for preparing the query. The actual
query execution will use the app profile specified in the
ExecuteQueryRequest. If not specified, the default application profile
will be used.
Required. param_types is a map of parameter identifier strings to their
Types.
In query string, a parameter placeholder consists of the
@ character followed by the parameter name (for example, @firstName) in
the query string.
For example, if param_types["firstName"] = Bytes then @firstName will be a
query parameter of type Bytes. The specific Value to be used for the
query execution must be sent in ExecuteQueryRequest in the params map.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-12 UTC."],[[["\u003cp\u003eThis document provides reference information for the \u003ccode\u003ePrepareQueryRequest\u003c/code\u003e class within the Google Cloud Bigtable v2 API for .NET.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ePrepareQueryRequest\u003c/code\u003e class is used to prepare a query for execution against a Google Bigtable instance, and it implements multiple interfaces including \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eKey properties of the \u003ccode\u003ePrepareQueryRequest\u003c/code\u003e class include \u003ccode\u003eAppProfileId\u003c/code\u003e, \u003ccode\u003eInstanceName\u003c/code\u003e, \u003ccode\u003eParamTypes\u003c/code\u003e, \u003ccode\u003eProtoFormat\u003c/code\u003e, and \u003ccode\u003eQuery\u003c/code\u003e, which are used to define the parameters and scope of the query.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version of the documentation available is 3.17.0, and there are also various older versions ranging from 3.16.0 down to 2.2.0, which are all accessible via links.\u003c/p\u003e\n"],["\u003cp\u003eThe namespace for the \u003ccode\u003ePrepareQueryRequest\u003c/code\u003e is \u003ccode\u003eGoogle.Cloud.Bigtable.V2\u003c/code\u003e and the class is a part of the \u003ccode\u003eGoogle.Cloud.Bigtable.V2.dll\u003c/code\u003e assembly.\u003c/p\u003e\n"]]],[],null,["# Google Bigtable v2 API - Class PrepareQueryRequest (3.23.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.23.0 (latest)](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/latest/Google.Cloud.Bigtable.V2.PrepareQueryRequest)\n- [3.22.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.22.0/Google.Cloud.Bigtable.V2.PrepareQueryRequest)\n- [3.21.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.21.0/Google.Cloud.Bigtable.V2.PrepareQueryRequest)\n- [3.20.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.20.0/Google.Cloud.Bigtable.V2.PrepareQueryRequest)\n- [3.19.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.19.0/Google.Cloud.Bigtable.V2.PrepareQueryRequest)\n- [3.18.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.18.0/Google.Cloud.Bigtable.V2.PrepareQueryRequest)\n- [3.17.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.17.0/Google.Cloud.Bigtable.V2.PrepareQueryRequest)\n- [3.16.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.16.0/Google.Cloud.Bigtable.V2.PrepareQueryRequest)\n- [3.15.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.15.0/Google.Cloud.Bigtable.V2.PrepareQueryRequest)\n- [3.14.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.14.0/Google.Cloud.Bigtable.V2.PrepareQueryRequest)\n- [3.13.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.13.0/Google.Cloud.Bigtable.V2.PrepareQueryRequest)\n- [3.12.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.12.0/Google.Cloud.Bigtable.V2.PrepareQueryRequest)\n- [3.11.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.11.0/Google.Cloud.Bigtable.V2.PrepareQueryRequest)\n- [3.10.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.10.0/Google.Cloud.Bigtable.V2.PrepareQueryRequest)\n- [3.9.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.9.0/Google.Cloud.Bigtable.V2.PrepareQueryRequest)\n- [3.8.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.8.0/Google.Cloud.Bigtable.V2.PrepareQueryRequest)\n- [3.7.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.7.0/Google.Cloud.Bigtable.V2.PrepareQueryRequest)\n- [3.6.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.6.0/Google.Cloud.Bigtable.V2.PrepareQueryRequest)\n- [3.5.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.5.0/Google.Cloud.Bigtable.V2.PrepareQueryRequest)\n- [3.4.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.4.0/Google.Cloud.Bigtable.V2.PrepareQueryRequest)\n- [3.3.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.3.0/Google.Cloud.Bigtable.V2.PrepareQueryRequest)\n- [3.2.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.2.0/Google.Cloud.Bigtable.V2.PrepareQueryRequest)\n- [3.1.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.1.0/Google.Cloud.Bigtable.V2.PrepareQueryRequest)\n- [3.0.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.0.0/Google.Cloud.Bigtable.V2.PrepareQueryRequest)\n- [2.6.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/2.6.0/Google.Cloud.Bigtable.V2.PrepareQueryRequest)\n- [2.5.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/2.5.0/Google.Cloud.Bigtable.V2.PrepareQueryRequest)\n- [2.4.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/2.4.0/Google.Cloud.Bigtable.V2.PrepareQueryRequest)\n- [2.3.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/2.3.0/Google.Cloud.Bigtable.V2.PrepareQueryRequest)\n- [2.2.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/2.2.0/Google.Cloud.Bigtable.V2.PrepareQueryRequest) \n\n public sealed class PrepareQueryRequest : IMessage\u003cPrepareQueryRequest\u003e, IEquatable\u003cPrepareQueryRequest\u003e, IDeepCloneable\u003cPrepareQueryRequest\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Google Bigtable v2 API class PrepareQueryRequest.\n\nRequest message for Bigtable.PrepareQuery \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e PrepareQueryRequest \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[PrepareQueryRequest](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/latest/Google.Cloud.Bigtable.V2.PrepareQueryRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[PrepareQueryRequest](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/latest/Google.Cloud.Bigtable.V2.PrepareQueryRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[PrepareQueryRequest](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/latest/Google.Cloud.Bigtable.V2.PrepareQueryRequest), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.Bigtable.V2](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/latest/Google.Cloud.Bigtable.V2)\n\nAssembly\n--------\n\nGoogle.Cloud.Bigtable.V2.dll\n\nConstructors\n------------\n\n### PrepareQueryRequest()\n\n public PrepareQueryRequest()\n\n### PrepareQueryRequest(PrepareQueryRequest)\n\n public PrepareQueryRequest(PrepareQueryRequest other)\n\nProperties\n----------\n\n### AppProfileId\n\n public string AppProfileId { get; set; }\n\nOptional. This value specifies routing for preparing the query. Note that\nthis `app_profile_id` is only used for preparing the query. The actual\nquery execution will use the app profile specified in the\n`ExecuteQueryRequest`. If not specified, the `default` application profile\nwill be used.\n\n### DataFormatCase\n\n public PrepareQueryRequest.DataFormatOneofCase DataFormatCase { get; }\n\n### InstanceName\n\n public string InstanceName { get; set; }\n\nRequired. The unique name of the instance against which the query should be\nexecuted.\nValues are of the form `projects/\u003cproject\u003e/instances/\u003cinstance\u003e`\n\n### InstanceNameAsInstanceName\n\n public InstanceName InstanceNameAsInstanceName { get; set; }\n\n[InstanceName](https://cloud.google.com/dotnet/docs/reference/Google.Cloud.Bigtable.Common.V2/latest/Google.Cloud.Bigtable.Common.V2.InstanceName.html)-typed view over the [InstanceName](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/latest/Google.Cloud.Bigtable.V2.PrepareQueryRequest#Google_Cloud_Bigtable_V2_PrepareQueryRequest_InstanceName) resource name property.\n\n### ParamTypes\n\n public MapField\u003cstring, Type\u003e ParamTypes { get; }\n\nRequired. `param_types` is a map of parameter identifier strings to their\n`Type`s.\n\nIn query string, a parameter placeholder consists of the\n`@` character followed by the parameter name (for example, `@firstName`) in\nthe query string.\n\nFor example, if param_types\\[\"firstName\"\\] = Bytes then @firstName will be a\nquery parameter of type Bytes. The specific `Value` to be used for the\nquery execution must be sent in `ExecuteQueryRequest` in the `params` map.\n\n### ProtoFormat\n\n public ProtoFormat ProtoFormat { get; set; }\n\nProtocol buffer format as described by ProtoSchema and ProtoRows\nmessages.\n\n### Query\n\n public string Query { get; set; }\n\nRequired. The query string."]]
