Administra el optimizador de consultas

El optimizador de consultas de Spanner determina la forma más eficiente de ejecutar una consulta en SQL. Sin embargo, el plan de consulta determinado por el optimizador puede cambiar un poco cuando el optimizador de consultas evoluciona o cuando se actualizan las estadísticas de la base de datos. Para minimizar cualquier potencial de regresión de rendimiento cuando cambian el optimizador de consultas o las estadísticas, Spanner proporciona las siguientes opciones de consulta.

• optimizer_version: los cambios en el optimizador de consultas se agrupan y lanzan como versiones del optimizador. Spanner comienza a usar la versión más reciente del optimizador como predeterminada al menos 30 días después del lanzamiento de esa versión. Puedes usar la opción de versión del optimizador de consultas para ejecutar consultas en una versión anterior del optimizador.

• optimizer_statistics_package: Spanner actualiza las estadísticas del optimizador con regularidad. Las nuevas estadísticas están disponibles como un paquete. Esta opción de consulta especifica un paquete de estadísticas para que el optimizador de consultas lo utilice cuando compile una consulta en SQL. El paquete especificado debe tener inhabilitada la recolección de elementos no utilizados:

GoogleSQL

 ALTER STATISTICS  SET OPTIONS (allow_gc=false)

PostgreSQL

ALTER STATISTICS spanner."" SET OPTIONS (allow_gc = true)

En esta guía, se muestra cómo configurar estas opciones individuales en diferentes permisos en Spanner.

Mostrar opciones del optimizador de consultas

Spanner almacena información sobre las versiones disponibles del optimizador y los paquetes de estadísticas que puedes seleccionar.

Versiones del optimizador

La versión del optimizador de consultas es un valor de número entero, que se incrementa en 1 con cada actualización. La versión más reciente del optimizador de consultas es la 7.

Ejecuta la siguiente instrucción de SQL para mostrar una lista de todas las versiones compatibles del optimizador, junto con sus fechas de lanzamiento correspondientes y si esa versión es la predeterminada. El número de versión más grande que se muestra es la última versión compatible del optimizador.

SELECT * FROM SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS;

Versión predeterminada

De forma predeterminada, Spanner comienza a usar la versión más reciente del optimizador al menos 30 días después del lanzamiento de esa versión. Durante el período de más de 30 días entre el momento en que una actualización nueva se convierte en la predeterminada y esta se convierte en la predeterminada, te recomendamos que pruebes las consultas en la versión nueva para detectar cualquier regresión.

Para encontrar la versión predeterminada, ejecuta la siguiente instrucción de SQL:

SELECT * FROM SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS;

La consulta muestra una lista de todas las versiones compatibles del optimizador. En la columna IS_DEFAULT, se especifica qué versión es la predeterminada actual.

Para obtener detalles sobre cada versión, consulta Historial de versiones del optimizador de consultas.

Paquetes de estadísticas del optimizador

A cada paquete de estadísticas del optimizador nuevo que crea Spanner se le asigna un nombre de paquete que garantiza que es único dentro de la base de datos determinada.

El formato del nombre del paquete es auto_{PACKAGE_TIMESTAMP}UTC. En GoogleSQL, la instrucción ANALYZE activa la creación del nombre del paquete de estadísticas. En PostgreSQL, la declaración ANALYZE realiza esta tarea. El formato del nombre del paquete de estadísticas es analyze_{PACKAGE_TIMESTAMP}UTC, en el que {PACKAGE_TIMESTAMP} es la marca de tiempo, en zona horaria UTC, del momento en que comenzó la construcción de las estadísticas. Ejecuta la siguiente instrucción de SQL para mostrar una lista de todos los paquetes de estadísticas del optimizador disponibles.

SELECT * FROM INFORMATION_SCHEMA.SPANNER_STATISTICS;

De forma predeterminada, Spanner usa el paquete de estadísticas más reciente del optimizador, a menos que la base de datos o la consulta se fije a un paquete anterior mediante uno de los métodos descritos en esta página.

Prioridad de anulación de la opción

Si usas una base de datos de dialectos de GoogleSQL, Spanner ofrece varias formas de cambiar las opciones del optimizador. Por ejemplo, puedes establecer las opciones para una consulta específica o configurar la opción en la biblioteca cliente a nivel del proceso o de la consulta. Cuando una opción se configura de varias maneras, se aplica el siguiente orden de prioridad. (Selecciona un vínculo para pasar a esa sección de este documento).

Spanner predeterminado ← opción de base de datos ← app cliente ← variable de entorno ← consulta de cliente ← sugerencia de declaración

Por ejemplo, a continuación, se muestra cómo interpretar el orden de prioridad cuando se configura la versión del optimizador de consultas:

Cuando creas una base de datos, usa la versión del optimizador predeterminada de Spanner. La configuración de la versión del optimizador con uno de los métodos mencionados anteriormente tiene prioridad sobre cualquier elemento a la izquierda. Por ejemplo, configurar el optimizador para una app con una variable de entorno tiene prioridad sobre cualquier valor que configures para la base de datos con la opción de base de datos. La configuración de la versión del optimizador a través de una sugerencia de instrucción tiene la prioridad más alta para la consulta determinada, ya que tiene prioridad sobre el valor establecido con cualquier otro método.

Ahora analicemos cada método con más detalle.

Establece las opciones del optimizador a nivel de la base de datos

Puedes configurar la versión predeterminada del optimizador en una base de datos con el siguiente comando de DDL ALTER DATABASE.

GoogleSQL

ALTER DATABASE MyDatabase
SET OPTIONS (optimizer_version =  7);

PostgreSQL

ALTER DATABASE MyDatabase SET spanner.optimizer_version = 5;

Puedes configurar el paquete de estadísticas de manera similar, como se muestra en el siguiente ejemplo.

GoogleSQL

ALTER DATABASE MyDatabase
SET OPTIONS (optimizer_statistics_package = "auto_20191128_14_47_22UTC");

PostgreSQL

ALTER DATABASE MyDatabase
SET spanner.optimizer_statistics_package = "auto_20191128_14_47_22UTC";

También puedes configurar más de una opción al mismo tiempo, como se muestra en el siguiente comando de DDL.

GoogleSQL

ALTER DATABASE MyDatabase
SET OPTIONS (optimizer_version = 7,
            optimizer_statistics_package = "auto_20191128_14_47_22UTC");

Puedes ejecutar ALTER DATABASE en gcloud CLI con el comando gcloud CLI databases ddl update de la siguiente manera.

GoogleSQL

gcloud spanner databases ddl update MyDatabase --instance=test-instance \
    --ddl='ALTER DATABASE MyDatabase SET OPTIONS ( optimizer_version = 7 )'

PostgreSQL

gcloud spanner databases ddl update MyDatabase --instance=test-instance \
  --ddl='ALTER DATABASE MyDatabase SET spanner.optimizer_version = 7'

Si configuras una opción de base de datos como NULL (en GoogleSQL) o DEFAULT (en PostgreSQL), se borra para que se use el valor predeterminado.

Si deseas ver el valor actual de estas opciones para una base de datos, consulta la vista INFORMATION_SCHEMA.DATABASE_OPTIONS para GoogleSQL o la tabla information_schema database_options para PostgreSQL, de la siguiente manera.

GoogleSQL

SELECT
  s.OPTION_NAME,
  s.OPTION_VALUE
FROM
  INFORMATION_SCHEMA.DATABASE_OPTIONS s
WHERE
  s.SCHEMA_NAME=""
  AND s.OPTION_NAME IN ('optimizer_version', 'optimizer_statistics_package')

PostgreSQL

  SELECT
    s.option_name,
    s.option_value
  FROM
    information_schema.database_options s
  WHERE
    s.schema_name='public'
    AND s.option_name IN ('optimizer_version',
      'optimizer_statistics_package')

Establece opciones del optimizador con bibliotecas cliente

Cuando interactúas de manera programática con Spanner a través de bibliotecas cliente, hay varias formas de cambiar las opciones de consulta de la aplicación cliente.

Debes usar las versiones más recientes de las bibliotecas cliente para configurar las opciones del optimizador.

Establece opciones de optimizador para un cliente de base de datos

Una aplicación puede establecer las opciones del optimizador de forma global en la biblioteca cliente configurando la propiedad de opciones de consulta como se muestra en los siguientes fragmentos de código. La configuración del optimizador se almacena en la instancia del cliente y se aplica a todas las consultas ejecutadas durante el ciclo de vida del cliente. Si bien las opciones se aplican a nivel de base de datos en el backend, cuando se establecen a nivel de cliente, se aplican a todas las bases de datos conectadas a ese cliente.

C++

namespace spanner = ::google::cloud::spanner;
spanner::Client client(
    spanner::MakeConnection(db),
    google::cloud::Options{}
        .set<spanner::QueryOptimizerVersionOption>("1")
        .set<spanner::QueryOptimizerStatisticsPackageOption>(
            "auto_20191128_14_47_22UTC"));

C#

using Google.Cloud.Spanner.Data;
using System.Collections.Generic;
using System.Threading.Tasks;

public class CreateConnectionWithQueryOptionsAsyncSample
{
    public class Album
    {
        public int AlbumId { get; set; }
        public int SingerId { get; set; }
        public string AlbumTitle { get; set; }
    }

    public async Task<List<Album>> CreateConnectionWithQueryOptionsAsync(string projectId, string instanceId, string databaseId)
    {
        string connectionString = $"Data Source=projects/{projectId}/instances/{instanceId}/databases/{databaseId}";

        using var connection = new SpannerConnection(connectionString)
        {
            // Set query options on the connection.
            QueryOptions = QueryOptions.Empty
                .WithOptimizerVersion("1")
                // The list of available statistics packages for the database can
                // be found by querying the "INFORMATION_SCHEMA.SPANNER_STATISTICS"
                // table.
                .WithOptimizerStatisticsPackage("latest")
        };

        var albums = new List<Album>();
        var cmd = connection.CreateSelectCommand("SELECT SingerId, AlbumId, AlbumTitle FROM Albums");
        using var reader = await cmd.ExecuteReaderAsync();
        while (await reader.ReadAsync())
        {
            albums.Add(new Album
            {
                SingerId = reader.GetFieldValue<int>("SingerId"),
                AlbumId = reader.GetFieldValue<int>("AlbumId"),
                AlbumTitle = reader.GetFieldValue<string>("AlbumTitle")
            });
        }
        return albums;
    }
}

Go

import (
	"context"
	"fmt"
	"io"
	"time"

	"cloud.google.com/go/spanner"
	"google.golang.org/api/iterator"
	sppb "google.golang.org/genproto/googleapis/spanner/v1"
)

func createClientWithQueryOptions(w io.Writer, database string) error {
	ctx := context.Background()
	queryOptions := spanner.QueryOptions{
		Options: &sppb.ExecuteSqlRequest_QueryOptions{
			OptimizerVersion: "1",
			// The list of available statistics packages can be found by
			// querying the "INFORMATION_SCHEMA.SPANNER_STATISTICS" table.
			OptimizerStatisticsPackage: "latest",
		},
	}
	client, err := spanner.NewClientWithConfig(
		ctx, database, spanner.ClientConfig{QueryOptions: queryOptions},
	)
	if err != nil {
		return err
	}
	defer client.Close()

	stmt := spanner.Statement{SQL: `SELECT VenueId, VenueName, LastUpdateTime FROM Venues`}
	iter := client.Single().Query(ctx, stmt)
	defer iter.Stop()
	for {
		row, err := iter.Next()
		if err == iterator.Done {
			return nil
		}
		if err != nil {
			return err
		}
		var venueID int64
		var venueName string
		var lastUpdateTime time.Time
		if err := row.Columns(&venueID, &venueName, &lastUpdateTime); err != nil {
			return err
		}
		fmt.Fprintf(w, "%d %s %s\n", venueID, venueName, lastUpdateTime)
	}
}

Java

static void clientWithQueryOptions(DatabaseId db) {
  SpannerOptions options =
      SpannerOptions.newBuilder()
          .setDefaultQueryOptions(
              db, QueryOptions
                  .newBuilder()
                  .setOptimizerVersion("1")
                  // The list of available statistics packages can be found by querying the
                  // "INFORMATION_SCHEMA.SPANNER_STATISTICS" table.
                  .setOptimizerStatisticsPackage("latest")
                  .build())
          .build();
  Spanner spanner = options.getService();
  DatabaseClient dbClient = spanner.getDatabaseClient(db);
  try (ResultSet resultSet =
      dbClient
          .singleUse()
          .executeQuery(Statement.of("SELECT SingerId, AlbumId, AlbumTitle FROM Albums"))) {
    while (resultSet.next()) {
      System.out.printf(
          "%d %d %s\n", resultSet.getLong(0), resultSet.getLong(1), resultSet.getString(2));
    }
  }
}

Node.js

// Imports the Google Cloud client library
const {Spanner} = require('@google-cloud/spanner');

/**
 * TODO(developer): Uncomment the following lines before running the sample.
 */
// const projectId = 'my-project-id';
// const instanceId = 'my-instance';
// const databaseId = 'my-database';

// Creates a client
const spanner = new Spanner({
  projectId: projectId,
});

// Gets a reference to a Cloud Spanner instance and database
const instance = spanner.instance(instanceId);
const database = instance.database(
  databaseId,
  {},
  {
    optimizerVersion: '1',
    // The list of available statistics packages can be found by querying the
    // "INFORMATION_SCHEMA.SPANNER_STATISTICS" table.
    optimizerStatisticsPackage: 'latest',
  }
);

const query = {
  sql: `SELECT AlbumId, AlbumTitle, MarketingBudget
        FROM Albums
        ORDER BY AlbumTitle`,
};

// Queries rows from the Albums table
try {
  const [rows] = await database.run(query);

  rows.forEach(row => {
    const json = row.toJSON();
    const marketingBudget = json.MarketingBudget
      ? json.MarketingBudget
      : null; // This value is nullable
    console.log(
      `AlbumId: ${json.AlbumId}, AlbumTitle: ${json.AlbumTitle}, MarketingBudget: ${marketingBudget}`
    );
  });
} catch (err) {
  console.error('ERROR:', err);
} finally {
  // Close the database when finished.
  database.close();
}

PHP

use Google\Cloud\Spanner\SpannerClient;
use Google\Cloud\Spanner\Database;

/**
 * Create a client with query options.
 * Example:
 * ```
 * create_client_with_query_options($instanceId, $databaseId);
 * ```
 *
 * @param string $instanceId The Spanner instance ID.
 * @param string $databaseId The Spanner database ID.
 */
function create_client_with_query_options(string $instanceId, string $databaseId): void
{
    $spanner = new SpannerClient([
        'queryOptions' => [
            'optimizerVersion' => '1',
            // Pin the statistics package used for this client instance to the
            // latest version. The list of available statistics packages can be
            // found by querying the "INFORMATION_SCHEMA.SPANNER_STATISTICS"
            // table.
            'optimizerStatisticsPackage' => 'latest'
        ]
    ]);
    $instance = $spanner->instance($instanceId);
    $database = $instance->database($databaseId);

    $results = $database->execute(
        'SELECT VenueId, VenueName, LastUpdateTime FROM Venues'
    );

    foreach ($results as $row) {
        printf('VenueId: %s, VenueName: %s, LastUpdateTime: %s' . PHP_EOL,
            $row['VenueId'], $row['VenueName'], $row['LastUpdateTime']);
    }
}

Python

# instance_id = "your-spanner-instance"
# database_id = "your-spanner-db-id"
spanner_client = spanner.Client(
    query_options={
        "optimizer_version": "1",
        "optimizer_statistics_package": "latest",
    }
)
instance = spanner_client.instance(instance_id)
database = instance.database(database_id)

with database.snapshot() as snapshot:
    results = snapshot.execute_sql(
        "SELECT VenueId, VenueName, LastUpdateTime FROM Venues"
    )

    for row in results:
        print("VenueId: {}, VenueName: {}, LastUpdateTime: {}".format(*row))

Rita

# project_id  = "Your Google Cloud project ID"
# instance_id = "Your Spanner instance ID"
# database_id = "Your Spanner database ID"

require "google/cloud/spanner"

query_options = {
  optimizer_version: "1",
  # The list of available statistics packages can be
  # found by querying the "INFORMATION_SCHEMA.SPANNER_STATISTICS"
  # table.
  optimizer_statistics_package: "latest"
}

spanner = Google::Cloud::Spanner.new project: project_id
client  = spanner.client instance_id, database_id, query_options: query_options

sql_query = "SELECT VenueId, VenueName, LastUpdateTime FROM Venues"

client.execute(sql_query).rows.each do |row|
  puts "#{row[:VenueId]} #{row[:VenueName]} #{row[:LastUpdateTime]}"
end

Establece las opciones del optimizador con variables de entorno

Para que te resulte más fácil probar diferentes configuraciones del optimizador sin tener que volver a compilar tu app, puedes configurar las variables de entorno SPANNER_OPTIMIZER_VERSION y SPANNER_OPTIMIZER_STATISTICS_PACKAGE, y ejecutar tu app, como se muestra en el siguiente fragmento.

Linux/macOS

export SPANNER_OPTIMIZER_VERSION="7"
export SPANNER_OPTIMIZER_STATISTICS_PACKAGE="auto_20191128_14_47_22UTC"

Windows

set SPANNER_OPTIMIZER_VERSION="7"
  set SPANNER_OPTIMIZER_STATISTICS_PACKAGE="auto_20191128_14_47_22UTC"

Los valores especificados de las opciones del optimizador de consultas se leen y almacenan en la instancia del cliente en el momento de la inicialización y se aplican a todas las consultas ejecutadas durante el ciclo de vida del cliente.

Establece opciones de optimizador para una consulta de cliente

Puedes especificar un valor para la versión del optimizador o la versión del paquete de estadísticas a nivel de la consulta en tu aplicación cliente. Para ello, especifica una propiedad de opciones de consulta cuando compilas tu consulta.

C++

void QueryWithQueryOptions(google::cloud::spanner::Client client) {
  namespace spanner = ::google::cloud::spanner;
  auto sql = spanner::SqlStatement("SELECT SingerId, FirstName FROM Singers");
  auto opts =
      google::cloud::Options{}
          .set<spanner::QueryOptimizerVersionOption>("1")
          .set<spanner::QueryOptimizerStatisticsPackageOption>("latest");
  auto rows = client.ExecuteQuery(std::move(sql), std::move(opts));

  using RowType = std::tuple<std::int64_t, std::string>;
  for (auto& row : spanner::StreamOf<RowType>(rows)) {
    if (!row) throw std::move(row).status();
    std::cout << "SingerId: " << std::get<0>(*row) << "\t";
    std::cout << "FirstName: " << std::get<1>(*row) << "\n";
  }
  std::cout << "Read completed for [spanner_query_with_query_options]\n";
}

C#

using Google.Cloud.Spanner.Data;
using System.Collections.Generic;
using System.Threading.Tasks;

public class RunCommandWithQueryOptionsAsyncSample
{
    public class Album
    {
        public int SingerId { get; set; }
        public int AlbumId { get; set; }
        public string AlbumTitle { get; set; }
    }

    public async Task<List<Album>> RunCommandWithQueryOptionsAsync(string projectId, string instanceId, string databaseId)
    {
        var connectionString = $"Data Source=projects/{projectId}/instances/{instanceId}/databases/{databaseId}";
        using var connection = new SpannerConnection(connectionString);
        using var cmd = connection.CreateSelectCommand("SELECT SingerId, AlbumId, AlbumTitle FROM Albums");

        cmd.QueryOptions = QueryOptions.Empty
            .WithOptimizerVersion("1")
            // The list of available statistics packages for the database can
            // be found by querying the "INFORMATION_SCHEMA.SPANNER_STATISTICS"
            // table.
            .WithOptimizerStatisticsPackage("latest");
        var albums = new List<Album>();
        using var reader = await cmd.ExecuteReaderAsync();
        while (await reader.ReadAsync())
        {
            albums.Add(new Album()
            {
                AlbumId = reader.GetFieldValue<int>("AlbumId"),
                SingerId = reader.GetFieldValue<int>("SingerId"),
                AlbumTitle = reader.GetFieldValue<string>("AlbumTitle")
            });
        }
        return albums;
    }
}

Go

import (
	"context"
	"fmt"
	"io"
	"time"

	"cloud.google.com/go/spanner"
	"google.golang.org/api/iterator"
	sppb "google.golang.org/genproto/googleapis/spanner/v1"
)

func queryWithQueryOptions(w io.Writer, db string) error {
	ctx := context.Background()
	client, err := spanner.NewClient(ctx, db)
	if err != nil {
		return err
	}
	defer client.Close()

	stmt := spanner.Statement{SQL: `SELECT VenueId, VenueName, LastUpdateTime FROM Venues`}
	queryOptions := spanner.QueryOptions{
		Options: &sppb.ExecuteSqlRequest_QueryOptions{
			OptimizerVersion: "1",
			// The list of available statistics packages can be found by
			// querying the "INFORMATION_SCHEMA.SPANNER_STATISTICS" table.
			OptimizerStatisticsPackage: "latest",
		},
	}
	iter := client.Single().QueryWithOptions(ctx, stmt, queryOptions)
	defer iter.Stop()
	for {
		row, err := iter.Next()
		if err == iterator.Done {
			return nil
		}
		if err != nil {
			return err
		}
		var venueID int64
		var venueName string
		var lastUpdateTime time.Time
		if err := row.Columns(&venueID, &venueName, &lastUpdateTime); err != nil {
			return err
		}
		fmt.Fprintf(w, "%d %s %s\n", venueID, venueName, lastUpdateTime)
	}
}

Java

static void queryWithQueryOptions(DatabaseClient dbClient) {
  try (ResultSet resultSet =
      dbClient
          .singleUse()
          .executeQuery(
              Statement
                  .newBuilder("SELECT SingerId, AlbumId, AlbumTitle FROM Albums")
                  .withQueryOptions(QueryOptions
                      .newBuilder()
                      .setOptimizerVersion("1")
                      // The list of available statistics packages can be found by querying the
                      // "INFORMATION_SCHEMA.SPANNER_STATISTICS" table.
                      .setOptimizerStatisticsPackage("latest")
                      .build())
                  .build())) {
    while (resultSet.next()) {
      System.out.printf(
          "%d %d %s\n", resultSet.getLong(0), resultSet.getLong(1), resultSet.getString(2));
    }
  }
}

Node.js

// Imports the Google Cloud client library
const {Spanner} = require('@google-cloud/spanner');

/**
 * TODO(developer): Uncomment the following lines before running the sample.
 */
// const projectId = 'my-project-id';
// const instanceId = 'my-instance';
// const databaseId = 'my-database';

// Creates a client
const spanner = new Spanner({
  projectId: projectId,
});

// Gets a reference to a Cloud Spanner instance and database
const instance = spanner.instance(instanceId);
const database = instance.database(databaseId);

const query = {
  sql: `SELECT AlbumId, AlbumTitle, MarketingBudget
        FROM Albums
        ORDER BY AlbumTitle`,
  queryOptions: {
    optimizerVersion: 'latest',
    // The list of available statistics packages can be found by querying the
    // "INFORMATION_SCHEMA.SPANNER_STATISTICS" table.
    optimizerStatisticsPackage: 'latest',
  },
};

// Queries rows from the Albums table
try {
  const [rows] = await database.run(query);

  rows.forEach(row => {
    const json = row.toJSON();
    const marketingBudget = json.MarketingBudget
      ? json.MarketingBudget
      : null; // This value is nullable
    console.log(
      `AlbumId: ${json.AlbumId}, AlbumTitle: ${json.AlbumTitle}, MarketingBudget: ${marketingBudget}`
    );
  });
} catch (err) {
  console.error('ERROR:', err);
} finally {
  // Close the database when finished.
  database.close();
}

PHP

use Google\Cloud\Spanner\SpannerClient;
use Google\Cloud\Spanner\Database;

/**
 * Queries sample data using SQL with query options.
 * Example:
 * ```
 * query_data_with_query_options($instanceId, $databaseId);
 * ```
 *
 * @param string $instanceId The Spanner instance ID.
 * @param string $databaseId The Spanner database ID.
 */
function query_data_with_query_options(string $instanceId, string $databaseId): void
{
    $spanner = new SpannerClient();
    $instance = $spanner->instance($instanceId);
    $database = $instance->database($databaseId);

    $results = $database->execute(
        'SELECT VenueId, VenueName, LastUpdateTime FROM Venues',
        [
            'queryOptions' => [
                'optimizerVersion' => '1',
                // Pin the statistics package to the latest version just for
                // this query.
                'optimizerStatisticsPackage' => 'latest'
            ]
        ]
    );

    foreach ($results as $row) {
        printf('VenueId: %s, VenueName: %s, LastUpdateTime: %s' . PHP_EOL,
            $row['VenueId'], $row['VenueName'], $row['LastUpdateTime']);
    }
}

Python

# instance_id = "your-spanner-instance"
# database_id = "your-spanner-db-id"
spanner_client = spanner.Client()
instance = spanner_client.instance(instance_id)
database = instance.database(database_id)

with database.snapshot() as snapshot:
    results = snapshot.execute_sql(
        "SELECT VenueId, VenueName, LastUpdateTime FROM Venues",
        query_options={
            "optimizer_version": "1",
            "optimizer_statistics_package": "latest",
        },
    )

    for row in results:
        print("VenueId: {}, VenueName: {}, LastUpdateTime: {}".format(*row))

Rita

# project_id  = "Your Google Cloud project ID"
# instance_id = "Your Spanner instance ID"
# database_id = "Your Spanner database ID"

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new project: project_id
client  = spanner.client instance_id, database_id

sql_query = "SELECT VenueId, VenueName, LastUpdateTime FROM Venues"
query_options = {
  optimizer_version: "1",
  # The list of available statistics packagebs can be
  # found by querying the "INFORMATION_SCHEMA.SPANNER_STATISTICS"
  # table.
  optimizer_statistics_package: "latest"
}

client.execute(sql_query, query_options: query_options).rows.each do |row|
  puts "#{row[:VenueId]} #{row[:VenueName]} #{row[:LastUpdateTime]}"
end

Establece opciones de optimizador para una consulta con una sugerencia de instrucción

Una sugerencia de instrucción es una sugerencia en una declaración de consulta que cambia la ejecución de la consulta desde el comportamiento predeterminado. Configurar la sugerencia OPTIMIZER_VERSION en una declaración obliga la ejecución de esa consulta mediante la versión del optimizador de consultas especificada.

La sugerencia OPTIMIZER_VERSION tiene la prioridad de versión más alta del optimizador. Si se especifica la sugerencia de instrucción, se utilizará independientemente de todas las demás configuraciones de la versión del optimizador.

GoogleSQL

@{OPTIMIZER_VERSION=7} SELECT * FROM MyTable;

PostgreSQL

/*@OPTIMIZER_VERSION=7*/ SELECT * FROM MyTable;

También puedes usar el literal latest_version para configurar la versión del optimizador para una consulta en la versión más reciente, como se muestra aquí.

GoogleSQL

@{OPTIMIZER_VERSION=latest_version} SELECT * FROM MyTable;

PostgreSQL

/*@OPTIMIZER_VERSION=latest_version*/ SELECT * FROM MyTable;

Configurar la sugerencia OPTIMIZER_STATISTICS_PACKAGE en una declaración obliga a esa consulta a ejecutarse mediante la versión especificada del paquete de estadísticas del optimizador de consultas. El paquete especificado debe tener inhabilitada la recolección de elementos no utilizados:

GoogleSQL

ALTER STATISTICS <package_name> SET OPTIONS (allow_gc=false)

PostgreSQL

ALTER STATISTICS spanner."package_name" SET OPTIONS (allow_gc=false)

La sugerencia OPTIMIZER_STATISTICS_PACKAGE tiene la prioridad más alta de configuración del paquete del optimizador. Si se especifica la sugerencia de instrucción, se usará independientemente de todas las demás opciones de configuración de la versión del paquete del optimizador.

@{OPTIMIZER_STATISTICS_PACKAGE=auto_20191128_14_47_22UTC} SELECT * FROM MyTable;

También puedes usar el literal latest para usar el paquete de estadísticas más reciente.

@{OPTIMIZER_STATISTICS_PACKAGE=latest} SELECT * FROM MyTable;

Ambas sugerencias se pueden configurar en una sola sentencia, como se muestra en el siguiente ejemplo.

El literal default_version configura la versión del optimizador para una consulta como la versión predeterminada, que puede ser diferente de la última versión. Consulta Versión predeterminada para obtener más detalles.

GoogleSQL

@{OPTIMIZER_VERSION=default_version, OPTIMIZER_STATISTICS_PACKAGE=auto_20191128_14_47_22UTC} SELECT * FROM MyTable;

PostgreSQL

/*@OPTIMIZER_VERSION=default_version, OPTIMIZER_STATISTICS_PACKAGE=auto_20191128_14_47_22UTC*/ SELECT * FROM KeyValue;

Establecer las opciones del optimizador cuando se usa el controlador JDBC de Spanner

Puedes anular el valor predeterminado de la versión del optimizador y el paquete de estadísticas si especificas opciones en la string de conexión de JDBC, como se muestra en el siguiente ejemplo.

Estas opciones solo son compatibles con las últimas versiones del controlador JDBC de Spanner.

import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;

class ConnectionWithQueryOptionsExample {

  static void connectionWithQueryOptions() throws SQLException {
    // TODO(developer): Replace these variables before running the sample.
    String projectId = "my-project";
    String instanceId = "my-instance";
    String databaseId = "my-database";
    connectionWithQueryOptions(projectId, instanceId, databaseId);
  }

  static void connectionWithQueryOptions(String projectId, String instanceId, String databaseId)
      throws SQLException {
    String optimizerVersion = "1";
    String connectionUrl =
        String.format(
            "jdbc:cloudspanner:/projects/%s/instances/%s/databases/%s?optimizerVersion=%s",
            projectId, instanceId, databaseId, optimizerVersion);
    try (Connection connection = DriverManager.getConnection(connectionUrl);
        Statement statement = connection.createStatement()) {
      // Execute a query using the optimizer version '1'.
      try (ResultSet rs =
          statement.executeQuery(
              "SELECT SingerId, FirstName, LastName FROM Singers ORDER BY LastName")) {
        while (rs.next()) {
          System.out.printf("%d %s %s%n", rs.getLong(1), rs.getString(2), rs.getString(3));
        }
      }
      try (ResultSet rs = statement.executeQuery("SHOW VARIABLE OPTIMIZER_VERSION")) {
        while (rs.next()) {
          System.out.printf("Optimizer version: %s%n", rs.getString(1));
        }
      }
    }
  }
}

También puedes configurar la versión del optimizador de consultas con la declaración SET OPTIMIZER_VERSION, como se muestra en el siguiente ejemplo.

import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;

class SetQueryOptionsExample {

  static void setQueryOptions() throws SQLException {
    // TODO(developer): Replace these variables before running the sample.
    String projectId = "my-project";
    String instanceId = "my-instance";
    String databaseId = "my-database";
    setQueryOptions(projectId, instanceId, databaseId);
  }

  static void setQueryOptions(String projectId, String instanceId, String databaseId)
      throws SQLException {
    String connectionUrl =
        String.format(
            "jdbc:cloudspanner:/projects/%s/instances/%s/databases/%s",
            projectId, instanceId, databaseId);
    try (Connection connection = DriverManager.getConnection(connectionUrl);
        Statement statement = connection.createStatement()) {
      // Instruct the JDBC connection to use version '1' of the query optimizer.
      // NOTE: Use `SET SPANNER.OPTIMIZER_VERSION='1`` when connected to a PostgreSQL database.
      statement.execute("SET OPTIMIZER_VERSION='1'");
      // Execute a query using the latest optimizer version.
      try (ResultSet rs =
          statement.executeQuery(
              "SELECT SingerId, FirstName, LastName FROM Singers ORDER BY LastName")) {
        while (rs.next()) {
          System.out.printf("%d %s %s%n", rs.getLong(1), rs.getString(2), rs.getString(3));
        }
      }
      // NOTE: Use `SHOW SPANNER.OPTIMIZER_VERSION` when connected to a PostgreSQL database.
      try (ResultSet rs = statement.executeQuery("SHOW VARIABLE OPTIMIZER_VERSION")) {
        while (rs.next()) {
          System.out.printf("Optimizer version: %s%n", rs.getString(1));
        }
      }
    }
  }
}

Para obtener más detalles sobre el uso del controlador de código abierto, consulta Usa el controlador JDBC de código abierto.

Cómo se controlan las versiones del optimizador no válidas

Spanner admite un rango de versiones del optimizador. Este rango cambia con el tiempo cuando se actualiza el optimizador de consultas. Si la versión que especificas está fuera del rango, la consulta falla. Por ejemplo, si intentas ejecutar una consulta con la sugerencia de instrucción @{OPTIMIZER_VERSION=8}, pero el número de versión más reciente del optimizador es solo 7, Spanner responde con este mensaje de error:

Query optimizer version: 8 is not supported

Controla una configuración no válida del paquete de estadísticas del optimizador

Puedes fijar tu base de datos o consulta a cualquier paquete de estadísticas disponible mediante uno de los métodos descritos anteriormente en esta página. Una consulta falla si se proporciona un nombre de paquete de estadísticas no válido. Un paquete de estadísticas especificado por una consulta debe tener alguno de los siguientes estados:

• configurado a nivel de base de datos
• marcado como ALLOW_GC=false

Determina la versión del optimizador de consultas que se usa para ejecutar una consulta

La versión del optimizador que se usa para una consulta es visible en la consola de Google Cloud y en Google Cloud CLI.

Consola de Google Cloud

Para ver la versión del optimizador que se usó para una consulta, ejecuta tu consulta en la página de Spanner Studio de la consola de Google Cloud y, luego, selecciona la pestaña Explicación. Deberías ver un mensaje similar al siguiente:

Versión del optimizador de consultas: 7

gcloud CLI

Para ver la versión que se usa cuando se ejecuta una consulta en gcloud CLI, establece la marca --query-mode en PROFILE, como se muestra en el siguiente fragmento.

gcloud spanner databases execute-sql MyDatabase --instance=test-instance \
    --query-mode=PROFILE --sql='SELECT * FROM MyTable'

Visualiza la versión del optimizador de consultas en el Explorador de métricas

Cloud Monitoring recopila medidas para ayudarte a comprender el rendimiento de las aplicaciones y los servicios del sistema. Una de las métricas recopiladas para Spanner es el recuento de consultas, que mide la cantidad de consultas en una instancia, que se muestrearon a lo largo del tiempo. Si bien esta métrica es muy útil para ver las consultas agrupadas por código de error, también podemos usarla para ver qué versión del optimizador se usó para ejecutar cada consulta.

Puedes usar el Explorador de métricas en la consola de Google Cloud para visualizar el Recuento de consultas de tu instancia de base de datos. En la Figura 1, se muestra el recuento de consultas para tres bases de datos. Puedes ver qué versión del optimizador se usa en cada base de datos.

En la tabla debajo del gráfico de esta figura, se muestra que my-db-1 intentó ejecutar una consulta con una versión del optimizador no válida, que mostró el estado Uso inadecuado y dio como resultado un recuento de consultas de 0. Las otras bases de datos ejecutaron consultas con las versiones 1 y 2 del optimizador, respectivamente.

Figura 1. Recuento de consultas que se muestra en el Explorador de métricas con consultas agrupadas por versión del optimizador.

Si deseas configurar un gráfico similar para tu instancia, sigue estos pasos:

1. Navega al Explorador de métricas en la consola de Google Cloud.
2. En el campo Tipo de recurso, selecciona Cloud Spanner Instance.
3. En el campo Métrica, selecciona Count of queries.
4. En el campo Agrupar por, selecciona database, optimizer_version y status.

No se muestra en este ejemplo cuando se usa una versión diferente del optimizador para distintas consultas en la misma base de datos. En ese caso, el gráfico mostraría un segmento de barra para cada combinación de base de datos y versión del optimizador.

Si deseas aprender a usar Cloud Monitoring para supervisar tus instancias de Spanner, consulta cómo supervisar con Cloud Monitoring.