Reference documentation and code samples for the Cloud Spanner V1 API module Google::Cloud::Spanner::V1::ExecuteSqlRequest::QueryMode.
Mode in which the statement must be processed.
Constants
NORMAL
value: 0 The default mode. Only the statement results are returned.
PLAN
value: 1 This mode returns only the query plan, without any results or
execution statistics information.
PROFILE
value: 2 This mode returns the query plan, overall execution statistics,
operator level execution statistics along with the results. This has a
performance overhead compared to the other modes. It is not recommended
to use this mode for production traffic.
WITH_STATS
value: 3 This mode returns the overall (but not operator-level) execution
statistics along with the results.
WITH_PLAN_AND_STATS
value: 4 This mode returns the query plan, overall (but not operator-level)
execution statistics along with the results.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Cloud Spanner V1 API - Module Google::Cloud::Spanner::V1::ExecuteSqlRequest::QueryMode (v1.10.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.10.0 (latest)](/ruby/docs/reference/google-cloud-spanner-v1/latest/Google-Cloud-Spanner-V1-ExecuteSqlRequest-QueryMode)\n- [1.9.1](/ruby/docs/reference/google-cloud-spanner-v1/1.9.1/Google-Cloud-Spanner-V1-ExecuteSqlRequest-QueryMode)\n- [1.8.0](/ruby/docs/reference/google-cloud-spanner-v1/1.8.0/Google-Cloud-Spanner-V1-ExecuteSqlRequest-QueryMode)\n- [1.7.1](/ruby/docs/reference/google-cloud-spanner-v1/1.7.1/Google-Cloud-Spanner-V1-ExecuteSqlRequest-QueryMode)\n- [1.6.0](/ruby/docs/reference/google-cloud-spanner-v1/1.6.0/Google-Cloud-Spanner-V1-ExecuteSqlRequest-QueryMode)\n- [1.5.0](/ruby/docs/reference/google-cloud-spanner-v1/1.5.0/Google-Cloud-Spanner-V1-ExecuteSqlRequest-QueryMode)\n- [1.4.0](/ruby/docs/reference/google-cloud-spanner-v1/1.4.0/Google-Cloud-Spanner-V1-ExecuteSqlRequest-QueryMode)\n- [1.3.0](/ruby/docs/reference/google-cloud-spanner-v1/1.3.0/Google-Cloud-Spanner-V1-ExecuteSqlRequest-QueryMode)\n- [1.2.0](/ruby/docs/reference/google-cloud-spanner-v1/1.2.0/Google-Cloud-Spanner-V1-ExecuteSqlRequest-QueryMode)\n- [1.1.0](/ruby/docs/reference/google-cloud-spanner-v1/1.1.0/Google-Cloud-Spanner-V1-ExecuteSqlRequest-QueryMode)\n- [1.0.2](/ruby/docs/reference/google-cloud-spanner-v1/1.0.2/Google-Cloud-Spanner-V1-ExecuteSqlRequest-QueryMode)\n- [0.27.0](/ruby/docs/reference/google-cloud-spanner-v1/0.27.0/Google-Cloud-Spanner-V1-ExecuteSqlRequest-QueryMode)\n- [0.26.0](/ruby/docs/reference/google-cloud-spanner-v1/0.26.0/Google-Cloud-Spanner-V1-ExecuteSqlRequest-QueryMode)\n- [0.25.0](/ruby/docs/reference/google-cloud-spanner-v1/0.25.0/Google-Cloud-Spanner-V1-ExecuteSqlRequest-QueryMode)\n- [0.24.0](/ruby/docs/reference/google-cloud-spanner-v1/0.24.0/Google-Cloud-Spanner-V1-ExecuteSqlRequest-QueryMode)\n- [0.23.0](/ruby/docs/reference/google-cloud-spanner-v1/0.23.0/Google-Cloud-Spanner-V1-ExecuteSqlRequest-QueryMode)\n- [0.22.2](/ruby/docs/reference/google-cloud-spanner-v1/0.22.2/Google-Cloud-Spanner-V1-ExecuteSqlRequest-QueryMode)\n- [0.21.0](/ruby/docs/reference/google-cloud-spanner-v1/0.21.0/Google-Cloud-Spanner-V1-ExecuteSqlRequest-QueryMode)\n- [0.20.1](/ruby/docs/reference/google-cloud-spanner-v1/0.20.1/Google-Cloud-Spanner-V1-ExecuteSqlRequest-QueryMode)\n- [0.19.0](/ruby/docs/reference/google-cloud-spanner-v1/0.19.0/Google-Cloud-Spanner-V1-ExecuteSqlRequest-QueryMode)\n- [0.18.0](/ruby/docs/reference/google-cloud-spanner-v1/0.18.0/Google-Cloud-Spanner-V1-ExecuteSqlRequest-QueryMode)\n- [0.17.0](/ruby/docs/reference/google-cloud-spanner-v1/0.17.0/Google-Cloud-Spanner-V1-ExecuteSqlRequest-QueryMode)\n- [0.16.0](/ruby/docs/reference/google-cloud-spanner-v1/0.16.0/Google-Cloud-Spanner-V1-ExecuteSqlRequest-QueryMode)\n- [0.15.1](/ruby/docs/reference/google-cloud-spanner-v1/0.15.1/Google-Cloud-Spanner-V1-ExecuteSqlRequest-QueryMode)\n- [0.14.1](/ruby/docs/reference/google-cloud-spanner-v1/0.14.1/Google-Cloud-Spanner-V1-ExecuteSqlRequest-QueryMode)\n- [0.13.0](/ruby/docs/reference/google-cloud-spanner-v1/0.13.0/Google-Cloud-Spanner-V1-ExecuteSqlRequest-QueryMode)\n- [0.12.0](/ruby/docs/reference/google-cloud-spanner-v1/0.12.0/Google-Cloud-Spanner-V1-ExecuteSqlRequest-QueryMode)\n- [0.11.0](/ruby/docs/reference/google-cloud-spanner-v1/0.11.0/Google-Cloud-Spanner-V1-ExecuteSqlRequest-QueryMode)\n- [0.10.0](/ruby/docs/reference/google-cloud-spanner-v1/0.10.0/Google-Cloud-Spanner-V1-ExecuteSqlRequest-QueryMode)\n- [0.9.0](/ruby/docs/reference/google-cloud-spanner-v1/0.9.0/Google-Cloud-Spanner-V1-ExecuteSqlRequest-QueryMode)\n- [0.8.1](/ruby/docs/reference/google-cloud-spanner-v1/0.8.1/Google-Cloud-Spanner-V1-ExecuteSqlRequest-QueryMode)\n- [0.7.4](/ruby/docs/reference/google-cloud-spanner-v1/0.7.4/Google-Cloud-Spanner-V1-ExecuteSqlRequest-QueryMode) \nReference documentation and code samples for the Cloud Spanner V1 API module Google::Cloud::Spanner::V1::ExecuteSqlRequest::QueryMode.\n\nMode in which the statement must be processed.\n\nConstants\n---------\n\n### NORMAL\n\n**value:** 0 \nThe default mode. Only the statement results are returned.\n\n### PLAN\n\n**value:** 1 \nThis mode returns only the query plan, without any results or\nexecution statistics information.\n\n### PROFILE\n\n**value:** 2 \nThis mode returns the query plan, overall execution statistics,\noperator level execution statistics along with the results. This has a\nperformance overhead compared to the other modes. It is not recommended\nto use this mode for production traffic.\n\n### WITH_STATS\n\n**value:** 3 \nThis mode returns the overall (but not operator-level) execution\nstatistics along with the results.\n\n### WITH_PLAN_AND_STATS\n\n**value:** 4 \nThis mode returns the query plan, overall (but not operator-level)\nexecution statistics along with the results."]]
