Se usó la API de Cloud Translation para traducir esta página.
Switch to English

Método: projects.databases.documents.runQuery

Ejecuta una consulta.

Solicitud HTTP

POST https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*/documents}:runQuery

La URL utiliza la sintaxis de transcodificación gRPC .

Parámetros de ruta

Parámetros
parent

string

Necesario. El nombre del recurso principal. En el formato: projects/{project_id}/databases/{database_id}/documents o projects/{project_id}/databases/{database_id}/documents/{document_path} . Por ejemplo: projects/my-project/databases/my-database/documents o projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

Cuerpo de solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON
 {
  "structuredQuery" :  {
    object ( StructuredQuery )
  } ,

  // Union field consistency_selector can be only one of the following:
  "transaction" :  string ,
  "newTransaction" :  {
    object ( TransactionOptions )
  } ,
  "readTime" :  string
  // End of list of possible types for union field consistency_selector .
} 
Campos
structuredQuery

object ( StructuredQuery )

Una consulta estructurada.

Campo de unión consistency_selector . El modo de coherencia para esta transacción. Si no se establece, el valor predeterminado es una consistencia fuerte consistency_selector puede ser solo uno de los siguientes:
transaction

string ( bytes format)

Lee documentos en una transacción.

Una cadena codificada en base64.

newTransaction

object ( TransactionOptions )

Inicia una nueva transacción y lee los documentos. El valor predeterminado es una transacción de solo lectura. El nuevo ID de transacción se devolverá como la primera respuesta en la secuencia.

readTime

string ( Timestamp format)

Lee los documentos tal como estaban en el momento dado. Esto no puede ser anterior a 270 segundos.

Una marca de tiempo en formato RFC3339 UTC "Zulu", con resolución de nanosegundos y hasta nueve dígitos fraccionales. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z" .

Cuerpo de respuesta

Si tiene éxito, el cuerpo de respuesta contiene datos con la siguiente estructura:

La respuesta para Firestore.RunQuery .

Representación JSON
 {
  "transaction" :  string ,
  "document" :  {
    object ( Document )
  } ,
  "readTime" :  string ,
  "skippedResults" :  integer
} 
Campos
transaction

string ( bytes format)

La transacción que se inició como parte de esta solicitud. Solo se puede establecer en la primera respuesta, y solo si RunQueryRequest.new_transaction se configuró en la solicitud. Si se establece, no se establecerán otros campos en esta respuesta.

Una cadena codificada en base64.

document

object ( Document )

Un resultado de consulta. No se establece cuando se informa un progreso parcial.

readTime

string ( Timestamp format)

La hora a la que se leyó el documento. Esto puede estar aumentando monotónicamente; en este caso, se garantiza que los documentos anteriores en la secuencia de resultados no hayan cambiado entre su readTime y este.

Si la consulta no devuelve resultados, se readTime una respuesta con readTime y ningún document , y esto representa el momento en que se ejecutó la consulta.

Una marca de tiempo en formato RFC3339 UTC "Zulu", con resolución de nanosegundos y hasta nueve dígitos fraccionales. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z" .

skippedResults

integer

El número de resultados que se han omitido debido a un desplazamiento entre la última respuesta y la respuesta actual.

Ámbitos de autorización

Requiere uno de los siguientes ámbitos de OAuth:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulte la Descripción general de la autenticación .