Package google.firestore.v1

map<string, Value >

El resultado de las funciones de agregación, por ejemplo: COUNT(*) AS total_docs .

La clave es el alias asignado a la función de agregación en la entrada y el tamaño de este mapa es igual al número de funciones de agregación en la consulta.

Value

Valores en la matriz.

string

Requerido. El nombre de la base de datos. En el formato: projects/{project_id}/databases/{database_id} .

string

Los nombres de los documentos a recuperar. En el formato: projects/{project_id}/databases/{database_id}/documents/{document_path} . La solicitud fallará si alguno de los documentos no es un recurso secundario de la database dada. Se eliminarán los nombres duplicados.

DocumentMask

Los campos a devolver. Si no se establece, devuelve todos los campos.

Si un documento tiene un campo que no está presente en esta máscara, ese campo no se devolverá en la respuesta.

bytes

Lee documentos en una transacción.

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 primera respuesta en la secuencia.

Timestamp

Lee documentos tal como estaban en el momento dado.

Debe ser una marca de tiempo con precisión de microsegundos dentro de la última hora o, si la recuperación de un punto en el tiempo está habilitada, también puede ser una marca de tiempo de un minuto completo dentro de los últimos 7 días.

bytes

La transacción que se inició como parte de esta solicitud. Solo se establecerá en la primera respuesta y solo si BatchGetDocumentsRequest.new_transaction se configuró en la solicitud.

Timestamp

Hora a la que se leyó el documento. Esto puede estar aumentando monóticamente; en este caso, se garantiza que los documentos anteriores en el flujo de resultados no habrán cambiado entre su tiempo de lectura y este.

Document

Un documento que fue solicitado.

string

Un nombre de documento que se solicitó pero no existe. En el formato: projects/{project_id}/databases/{database_id}/documents/{document_path} .

string

Requerido. El nombre de la base de datos. En el formato: projects/{project_id}/databases/{database_id} .

Write

Los escritos para aplicar.

El método no se aplica, escribe de forma atómica y no garantiza el pedido. Cada escritura tiene éxito o falla de forma independiente. No puede escribir en el mismo documento más de una vez por solicitud.

map<string, string>

Etiquetas asociadas con este lote de escritura.

WriteResult

El resultado de aplicar las escrituras.

Este i-ésimo resultado de escritura corresponde a la i-ésima escritura en la solicitud.

Status

El estado de aplicación de las escrituras.

Este i-ésimo estado de escritura corresponde a la i-ésima escritura en la solicitud.

string

Requerido. El nombre de la base de datos. En el formato: projects/{project_id}/databases/{database_id} .

TransactionOptions

Las opciones para la transacción. El valor predeterminado es una transacción de lectura y escritura.

bytes

La transacción que se inició.

bytes

Los bytes que codifican la secuencia de bits. Puede tener una longitud de cero.

int32

El número de bits del último byte del bitmap que se ignorarán como "relleno". Si la longitud del mapa de bitmap es cero, entonces este valor debe ser 0 . En caso contrario, este valor debe estar entre 0 y 7, inclusive.

BitSequence

Los datos del filtro de floración.

int32

El número de hashes utilizados por el algoritmo.

string

Requerido. El nombre de la base de datos. En el formato: projects/{project_id}/databases/{database_id} .

Write

Los escritos para aplicar.

Siempre ejecutado de forma atómica y en orden.

bytes

Si se establece, aplica todas las escrituras en esta transacción y la confirma.

WriteResult

El resultado de aplicar las escrituras.

Este i-ésimo resultado de escritura corresponde a la i-ésima escritura en la solicitud.

Timestamp

La hora a la que se produjo la confirmación. Se garantiza que cualquier lectura con un read_time igual o mayor verá los efectos de la confirmación.

string

Requerido. El recurso principal. Por ejemplo: projects/{project_id}/databases/{database_id}/documents o projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}

string

Requerido. El ID de la colección, relativo al parent , para enumerar. Por ejemplo: chatrooms .

string

El ID del documento asignado por el cliente que se utilizará para este documento.

Opcional. Si no se especifica, el servicio asignará una identificación.

Document

Requerido. El documento a crear. No se debe establecer name .

DocumentMask

Los campos a devolver. Si no se establece, devuelve todos los campos.

Si el documento tiene un campo que no está presente en esta máscara, ese campo no se devolverá en la respuesta.

Value

Los valores que representan una posición, en el orden en que aparecen en la cláusula order by de una consulta.

Puede contener menos valores de los especificados en la cláusula ordenar por.

bool

Si la posición está justo antes o después de los valores dados, en relación con el orden de clasificación definido por la consulta.

string

Requerido. El nombre del recurso del documento que se va a eliminar. En el formato: projects/{project_id}/databases/{database_id}/documents/{document_path} .

Precondition

Una condición previa opcional en el documento. La solicitud fallará si esto se establece y el documento de destino no lo cumple.

string

El nombre del recurso del documento, por ejemplo projects/{project_id}/databases/{database_id}/documents/{document_path} .

map<string, Value >

Timestamp

Sólo salida. La hora en la que se creó el documento.

Este valor aumenta monótonamente cuando se elimina un documento y luego se vuelve a crear. También se puede comparar con valores de otros documentos y el read_time de una consulta.

Timestamp

Sólo salida. La hora a la que se modificó el documento por última vez.

Este valor se establece inicialmente en create_time y luego aumenta monótonamente con cada cambio en el documento. También se puede comparar con valores de otros documentos y el read_time de una consulta.

Document

El nuevo estado del Document .

Si se establece mask , contiene solo los campos que se actualizaron o agregaron.

int32

Un conjunto de ID de objetivos que coinciden con este documento.

int32

Un conjunto de ID de objetivos para objetivos que ya no coinciden con este documento.

string

El nombre del recurso del Document que se eliminó.

int32

Un conjunto de ID de objetivos para objetivos que anteriormente coincidían con esta entidad.

Timestamp

La marca de tiempo de lectura en la que se observó la eliminación.

Mayor o igual al commit_time de la eliminación.

string

La lista de rutas de campo en la máscara. Consulte Document.fields para obtener una referencia de sintaxis de ruta de campo.

string

El nombre del recurso del Document que ha desaparecido de la vista.

int32

Un conjunto de ID de objetivos para objetivos que anteriormente coincidían con este documento.

Timestamp

La marca de tiempo de lectura en la que se observó la eliminación.

Mayor o igual al commit_time del cambio/eliminación/eliminación.

string

El nombre del documento a transformar.

FieldTransform

La lista de transformaciones que se aplicarán a los campos del documento, en orden. Esto no debe estar vacío.

string

El camino del campo. Consulte Document.fields para obtener la referencia de sintaxis de la ruta del campo.

ServerValue

Establece el campo al valor del servidor dado.

Value

Agrega el valor dado al valor actual del campo.

Debe ser un valor entero o doble. Si el campo no es un número entero o doble, o si el campo aún no existe, la transformación establecerá el campo en el valor dado. Si cualquiera de los valores dados o el valor del campo actual son dobles, ambos valores se interpretarán como dobles. La aritmética doble y la representación de valores dobles siguen la semántica IEEE 754. Si hay un desbordamiento de enteros positivos/negativos, el campo se resuelve al entero positivo/negativo de mayor magnitud.

Value

Establece el campo al máximo de su valor actual y el valor dado.

Debe ser un valor entero o doble. Si el campo no es un número entero o doble, o si el campo aún no existe, la transformación establecerá el campo en el valor dado. Si se aplica una operación máxima donde el campo y el valor de entrada son de tipos mixtos (es decir, uno es un número entero y el otro es doble), el campo adopta el tipo del operando mayor. Si los operandos son equivalentes (por ejemplo, 3 y 3,0), el campo no cambia. 0, 0,0 y -0,0 son todos cero. El máximo de un valor almacenado cero y un valor de entrada cero es siempre el valor almacenado. El máximo de cualquier valor numérico x y NaN es NaN.

Value

Establece el campo al mínimo de su valor actual y el valor dado.

Debe ser un valor entero o doble. Si el campo no es un número entero o doble, o si el campo aún no existe, la transformación establecerá el campo en el valor de entrada. Si se aplica una operación mínima donde el campo y el valor de entrada son de tipos mixtos (es decir, uno es un número entero y el otro es doble), el campo adopta el tipo del operando más pequeño. Si los operandos son equivalentes (por ejemplo, 3 y 3,0), el campo no cambia. 0, 0,0 y -0,0 son todos cero. El mínimo de un valor almacenado cero y un valor de entrada cero es siempre el valor almacenado. El mínimo de cualquier valor numérico x y NaN es NaN.

ArrayValue

Agregue los elementos dados en orden si aún no están presentes en el valor del campo actual. Si el campo no es una matriz, o si el campo aún no existe, primero se establece en la matriz vacía.

Los números equivalentes de diferentes tipos (por ejemplo, 3L y 3,0) se consideran iguales al comprobar si falta un valor. NaN es igual a NaN y Null es igual a Null. Si la entrada contiene varios valores equivalentes, solo se considerará el primero.

El transform_result correspondiente será el valor nulo.

ArrayValue

Elimine todos los elementos dados de la matriz en el campo. Si el campo no es una matriz, o si el campo aún no existe, se establece en la matriz vacía.

Los números equivalentes de los diferentes tipos (por ejemplo, 3L y 3.0) se consideran iguales al decidir si se debe eliminar un elemento. NaN es igual a NaN y Null es igual a Null. Esto eliminará todos los valores equivalentes si hay duplicados.

El transform_result correspondiente será el valor nulo.

int32

El ID de destino al que se aplica este filtro.

int32

El recuento total de documentos que coinciden con target_id .

Si es diferente del recuento de documentos en el cliente que coinciden, el cliente debe determinar manualmente qué documentos ya no coinciden con el objetivo.

El cliente puede utilizar el filtro de floración unchanged_names para ayudar con esta determinación probando TODOS los nombres de los documentos con el filtro; Si el nombre del documento NO está en el filtro, significa que el documento ya no coincide con el objetivo.

BloomFilter

Un filtro de floración que, a pesar de su nombre, contiene las codificaciones de bytes UTF-8 de los nombres de recursos de TODOS los documentos que coinciden con target_id , en el formato projects/{project_id}/databases/{database_id}/documents/{document_path} .

Este filtro de floración puede omitirse a discreción del servidor, por ejemplo, si se considera que el cliente no lo utilizará o si es demasiado costoso desde el punto de vista computacional para calcularlo o transmitirlo. Los clientes deben manejar con elegancia la ausencia de este campo recurriendo a la lógica utilizada antes de que existiera este campo; es decir, vuelva a agregar el destino sin un token de reanudación para determinar qué documentos en la memoria caché del cliente no están sincronizados.

string

Requerido. El nombre del recurso del documento que se va a obtener. En el formato: projects/{project_id}/databases/{database_id}/documents/{document_path} .

DocumentMask

Los campos a devolver. Si no se establece, devuelve todos los campos.

Si el documento tiene un campo que no está presente en esta máscara, ese campo no se devolverá en la respuesta.

bytes

Lee el documento en una transacción.

Timestamp

Lee la versión del documento en el momento dado.

Debe ser una marca de tiempo con precisión de microsegundos dentro de la última hora o, si la recuperación de un punto en el tiempo está habilitada, también puede ser una marca de tiempo de un minuto completo dentro de los últimos 7 días.

string

Requerido. El documento principal. En el formato: projects/{project_id}/databases/{database_id}/documents/{document_path} . Por ejemplo: projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

int32

El número máximo de resultados que se devolverán.

string

Un token de página. Debe ser un valor de ListCollectionIdsResponse .

Timestamp

Lee documentos tal como estaban en el momento dado.

Debe ser una marca de tiempo con precisión de microsegundos dentro de la última hora o, si la recuperación de un punto en el tiempo está habilitada, también puede ser una marca de tiempo de un minuto completo dentro de los últimos 7 días.

string

Los identificadores de colección.

string

Un token de página que se puede utilizar para continuar la lista.

string

Requerido. 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

string

Opcional. El ID de la colección, relativo al parent , para enumerar.

Por ejemplo: chatrooms o messages .

Esto es opcional y, cuando no se proporciona, Firestore enumerará los documentos de todas las colecciones bajo el parent proporcionado.

int32

Opcional. El número máximo de documentos a devolver en una sola respuesta.

Firestore puede devolver menos que este valor.

string

Opcional. Un token de página, recibido de una respuesta anterior ListDocuments .

Proporcione esto para recuperar la página siguiente. Al paginar, todos los demás parámetros (con excepción de page_size ) deben coincidir con los valores establecidos en la solicitud que generó el token de página.

string

Opcional. La ordenación facultativa de los documentos a devolver.

Por ejemplo: priority desc, __name__ desc .

Esto refleja el ORDER BY utilizado en las consultas de Firestore pero en una representación de cadena. Cuando están ausentes, los documentos se ordenan según __name__ ASC .

DocumentMask

Opcional. Los campos a devolver. Si no se establece, devuelve todos los campos.

Si un documento tiene un campo que no está presente en esta máscara, ese campo no se devolverá en la respuesta.

bool

Si la lista muestra documentos faltantes.

Falta un documento si no existe, pero hay subdocumentos anidados debajo de él. Cuando sea verdadero, dichos documentos faltantes se devolverán con una clave, pero no tendrán los campos create_time o update_time establecidos.

Es posible que las solicitudes con show_missing no especifiquen where u order_by .

bytes

Realice la lectura como parte de una transacción ya activa.

Timestamp

Realice la lectura a la hora indicada.

Debe ser una marca de tiempo con precisión de microsegundos dentro de la última hora o, si la recuperación de un punto en el tiempo está habilitada, también puede ser una marca de tiempo de un minuto completo dentro de los últimos 7 días.

Document

Los documentos encontrados.

string

Un token para recuperar la siguiente página de documentos.

Si se omite este campo, no hay páginas posteriores.

string

Requerido. El nombre de la base de datos. En el formato: projects/{project_id}/databases/{database_id} .

map<string, string>

Las etiquetas asociadas con este cambio de destino.

Target

Un objetivo para agregar a esta transmisión.

int32

El ID de un objetivo para eliminar de esta secuencia.

TargetChange

Los objetivos han cambiado.

DocumentChange

Un Document ha cambiado.

DocumentDelete

Se ha eliminado un Document .

DocumentRemove

Se eliminó un Document de un destino (porque ya no es relevante para ese destino).

ExistenceFilter

Un filtro que se aplicará al conjunto de documentos devueltos previamente para el destino determinado.

Se devuelve cuando es posible que se hayan eliminado documentos del objetivo determinado, pero se desconocen los documentos exactos.

map<string, Value >

Los campos del mapa.

Las claves del mapa representan nombres de campos. Los nombres de campos que coinciden con la expresión regular __.*__ están reservados. Los nombres de campos reservados están prohibidos excepto en ciertos contextos documentados. Las claves del mapa, representadas como UTF-8, no deben exceder los 1500 bytes y no pueden estar vacías.

string

Requerido. El nombre del recurso principal. En el formato: projects/{project_id}/databases/{database_id}/documents . No se admiten nombres de recursos de documentos; sólo se pueden especificar nombres de recursos de bases de datos.

int64

El número máximo deseado de puntos de partición. Las particiones pueden devolverse en varias páginas de resultados. El número debe ser positivo. El número real de particiones devueltas puede ser menor.

Por ejemplo, esto se puede establecer en uno menos que el número de consultas paralelas que se ejecutarán o, al ejecutar un trabajo de canalización de datos, uno menos que el número de trabajadores o instancias informáticas disponibles.

string

El valor next_page_token devuelto por una llamada anterior a PartitionQuery que puede usarse para obtener un conjunto adicional de resultados. No hay garantías de pedido entre conjuntos de resultados. Por lo tanto, utilizar múltiples conjuntos de resultados requerirá fusionar los diferentes conjuntos de resultados.

Por ejemplo, dos llamadas posteriores utilizando un page_token pueden devolver:

• cursor B, cursor M, cursor Q
• cursor A, cursor U, cursor W

Para obtener un conjunto de resultados completo ordenado con respecto a los resultados de la consulta proporcionada a PartitionQuery, los conjuntos de resultados deben fusionarse: cursor A, cursor B, cursor M, cursor Q, cursor U, cursor W

int32

El número máximo de particiones que se devolverán en esta llamada, sujeto a partition_count .

Por ejemplo, si partition_count = 10 y page_size = 8, la primera llamada a PartitionQuery devolverá hasta 8 particiones y un next_page_token si existen más resultados. Una segunda llamada a PartitionQuery devolverá hasta 2 particiones, para completar el total de 10 especificadas en partition_count .

StructuredQuery

Una consulta estructurada. La consulta debe especificar una colección con todos los descendientes y ordenarse por nombre de forma ascendente. No se admiten otros filtros, orden por orden, límites, compensaciones y cursores de inicio/fin.

Timestamp

Lee documentos tal como estaban en el momento dado.

Debe ser una marca de tiempo con precisión de microsegundos dentro de la última hora o, si la recuperación de un punto en el tiempo está habilitada, también puede ser una marca de tiempo de un minuto completo dentro de los últimos 7 días.

Cursor

Resultados de la partición. Cada partición es un punto de división que RunQuery puede utilizar como punto inicial o final para los resultados de la consulta. Las solicitudes RunQuery deben realizarse con la misma consulta proporcionada a esta solicitud PartitionQuery. Los cursores de partición se ordenarán según el mismo orden que los resultados de la consulta proporcionada a PartitionQuery.

Por ejemplo, si una solicitud PartitionQuery devuelve los cursores de partición A y B, ejecutar las tres consultas siguientes devolverá el conjunto de resultados completo de la consulta original:

• consulta, end_at A
• consulta, inicio_en A, fin_en B
• consulta, inicio_en B

Un resultado vacío puede indicar que la consulta tiene muy pocos resultados para particionarse o que la consulta aún no es compatible con la partición.

string

Un token de página que se puede utilizar para solicitar un conjunto adicional de resultados, hasta el número especificado por partition_count en la solicitud PartitionQuery. Si está en blanco, no hay más resultados.

bool

Cuando se establece en true , el documento de destino debe existir. Cuando se establece en false , el documento de destino no debe existir.

Timestamp

Cuando se establece, el documento de destino debe existir y haberse actualizado por última vez en ese momento. La marca de tiempo debe estar alineada con microsegundos.

string

Requerido. El nombre de la base de datos. En el formato: projects/{project_id}/databases/{database_id} .

bytes

Requerido. La transacción a revertir.

string

Requerido. 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

StructuredAggregationQuery

Una consulta de agregación.

bytes

Ejecute la agregación dentro de una transacción ya activa.

El valor aquí es el ID de transacción opaco para ejecutar la consulta.

TransactionOptions

Inicia una nueva transacción como parte de la consulta, de forma predeterminada es de solo lectura.

El nuevo ID de transacción se devolverá como primera respuesta en la secuencia.

Timestamp

Ejecuta la consulta en la marca de tiempo dada.

Debe ser una marca de tiempo con precisión de microsegundos dentro de la última hora o, si la recuperación de un punto en el tiempo está habilitada, también puede ser una marca de tiempo de un minuto completo dentro de los últimos 7 días.

AggregationResult

Un único resultado de agregación.

No presente al informar el progreso parcial.

bytes

La transacción que se inició como parte de esta solicitud.

Solo presente en la primera respuesta cuando la solicitud solicita iniciar una nueva transacción.

Timestamp

La hora a la que se calculó el resultado agregado. Esto siempre aumenta monótonamente; en este caso, se garantiza que el AggregationResult anterior en la secuencia de resultados no habrá cambiado entre su read_time y este.

Si la consulta no arroja resultados, se enviará una respuesta con read_time y sin result , y esto representa el momento en que se ejecutó la consulta.

string

Requerido. 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

StructuredQuery

Una consulta estructurada.

bytes

Ejecute la consulta dentro de una transacción ya activa.

El valor aquí es el ID de transacción opaco para ejecutar la consulta.

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 primera respuesta en la secuencia.

Timestamp

Lee documentos tal como estaban en el momento dado.

Debe ser una marca de tiempo con precisión de microsegundos dentro de la última hora o, si la recuperación de un punto en el tiempo está habilitada, también puede ser una marca de tiempo de un minuto completo dentro de los últimos 7 días.

bytes

La transacción que se inició como parte de esta solicitud. Solo se puede configurar 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.

Document

Un resultado de consulta, no establecido al informar el progreso parcial.

Timestamp

Hora a la que se leyó el documento. Esto puede estar aumentando monótonamente; en este caso, se garantiza que los documentos anteriores en el flujo de resultados no habrán cambiado entre su read_time y este.

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

int32

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

bool

Si está presente, Firestore ha finalizado completamente la solicitud y no se devolverán más documentos.

Aggregation

Opcional. Serie de agregaciones para aplicar sobre los resultados de la structured_query .

Requiere:

• Un mínimo de una y un máximo de cinco agregaciones por consulta.

StructuredQuery

Consulta estructurada anidada.

string

Opcional. Nombre opcional del campo en el que almacenar el resultado de la agregación.

Si no se proporciona, Firestore elegirá un nombre predeterminado siguiendo el formato field_<incremental_id++> . Por ejemplo:

AGGREGATE
  COUNT_UP_TO(1) AS count_up_to_1,
  COUNT_UP_TO(2),
  COUNT_UP_TO(3) AS count_up_to_3,
  COUNT(*)
OVER (
  ...
);

se convierte en:

AGGREGATE
  COUNT_UP_TO(1) AS count_up_to_1,
  COUNT_UP_TO(2) AS field_1,
  COUNT_UP_TO(3) AS count_up_to_3,
  COUNT(*) AS field_2
OVER (
  ...
);

Requiere:

• Debe ser único en todos los alias de agregación.
• Cumplir con las limitaciones document field name .

Count

Agregador de conteo.

Sum

Agregador de sumas.

Avg

Agregador promedio.

FieldReference

El campo para agregar.

Int64Value

Opcional. Restricción opcional sobre el número máximo de documentos a contar.

Esto proporciona una manera de establecer un límite superior en la cantidad de documentos a escanear, limitando la latencia y el costo.

No especificado se interpreta como sin límite.

Ejemplo de alto nivel:

AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );

Requiere:

• Debe ser mayor que cero cuando esté presente.

FieldReference

El campo para agregar.

Projection

Subconjunto opcional de los campos a devolver.

Esto actúa como DocumentMask sobre los documentos devueltos por una consulta. Cuando no está configurado, se supone que la persona que llama quiere que se le devuelvan todos los campos.

CollectionSelector

Las colecciones a consultar.

Filter

El filtro a aplicar.

Order

El orden que se aplicará a los resultados de la consulta.

Firestore permite a las personas que llaman proporcionar un pedido completo, un pedido parcial o ningún pedido en absoluto. En todos los casos, Firestore garantiza un pedido estable a través de las siguientes reglas:

• Se requiere order_by para hacer referencia a todos los campos utilizados con un filtro de desigualdad.
• Todos los campos que deben estar en order_by pero que aún no están presentes se agregan en el orden lexicográfico del nombre del campo.
• Si no se especifica una orden en __name__ , se agrega de forma predeterminada.

Los campos se añaden con la misma dirección de clasificación que el último orden especificado, o 'ASCENDENTE' si no se especificó ningún orden. Por ejemplo:

• ORDER BY a se convierte en ORDER BY a ASC, __name__ ASC
• ORDER BY a DESC se convierte en ORDER BY a DESC, __name__ DESC
• WHERE a > 1 se convierte en WHERE a > 1 ORDER BY a ASC, __name__ ASC
• WHERE __name__ > ... AND a > 1 se convierte en WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC

Cursor

Un prefijo potencial de una posición en el conjunto de resultados para iniciar la consulta.

El orden del conjunto de resultados se basa en la cláusula ORDER BY de la consulta original.

SELECT * FROM k WHERE a = 1 AND b > 2 ORDER BY b ASC, __name__ ASC;

Los resultados de esta consulta están ordenados por (b ASC, __name__ ASC) .

Los cursores pueden hacer referencia al orden completo o a un prefijo de la ubicación, aunque no pueden hacer referencia a más campos que los que se encuentran en el ORDER BY proporcionado.

Siguiendo con el ejemplo anterior, adjuntar los siguientes cursores de inicio tendrá un impacto variable:

• START BEFORE (2, /k/123) : inicie la consulta justo antes a = 1 AND b > 2 AND __name__ > /k/123 .
• START AFTER (10) : inicie la consulta justo después a = 1 AND b > 10 .

A diferencia OFFSET , que requiere escanear los primeros n. No se requiere esta posición para que coincida con un resultado real, escaneará hacia adelante desde esta posición para encontrar el siguiente documento.

Requiere:

• El número de valores no puede ser mayor que el número de campos especificados en el ORDER BY cláusula.

Cursor

Un prefijo potencial de una posición en el resultado establecido para finalizar la consulta en.

Esto es similar a START_AT , pero con él controlando la posición final en lugar de la posición de inicio.

Requiere:

• El número de valores no puede ser mayor que el número de campos especificados en el ORDER BY cláusula.

int32

El número de documentos para omitir antes de devolver el primer resultado.

Esto se aplica después de las restricciones especificadas por el WHERE , START AT y END AT pero antes de la cláusula LIMIT .

Requiere:

• El valor debe ser mayor o igual a cero si se especifica.

Int32Value

El número máximo de resultados para devolver.

Se aplica después de todas las otras restricciones.

Requiere:

• El valor debe ser mayor o igual a cero si se especifica.

string

La identificación de la colección. Cuando se establece, selecciona solo colecciones con esta ID.

bool

Cuando False, selecciona solo colecciones que son hijos inmediatos del parent especificados en RunQueryRequest que contiene. Cuando es cierto, selecciona todas las colecciones descendientes.

Operator

El operador para combinar múltiples filtros.

Filter

La lista de filtros para combinar.

Requiere:

• Al menos un filtro está presente.

FieldReference

El campo para filtrar por.

Operator

El operador para filtrar por.

Value

El valor para comparar.

string

Una referencia a un campo en un documento.

Requiere:

• Debe ser una cadena de segmentos ( . ) Dotelimited (.), Donde cada segmento se ajusta al document field name .

CompositeFilter

Un filtro compuesto.

FieldFilter

Un filtro en un campo de documento.

UnaryFilter

Un filtro que toma exactamente un argumento.

FieldReference

El campo para ordenar por.

Direction

La dirección para ordenar por. El valor predeterminado es ASCENDING .

FieldReference

Los campos para regresar.

Si está vacío, todos los campos se devuelven. Para devolver solo el nombre del documento, use ['__name__'] .

Operator

El operador unario para aplicar.

FieldReference

El campo al que aplicar el operador.

int32

La ID de destino que identifica el objetivo en la transmisión. Debe ser un número positivo y no cero.

Si target_id es 0 (o no especificado), el servidor asignará una ID para este objetivo y lo devolverá en un evento TargetChange::ADD . Una vez que se agrega un objetivo con target_id=0 , todos los objetivos posteriores también deben tener target_id=0 . Si se envía una solicitud AddTarget con target_id != 0 al servidor después de que se agrega un objetivo con target_id=0 , el servidor enviará inmediatamente una respuesta con un evento TargetChange::Remove .

Tenga en cuenta que si el cliente envía múltiples solicitudes AddTarget sin una ID, el orden de IDS devuelto en TargetChage.target_ids no está definido. Por lo tanto, los clientes deben proporcionar una ID de destino en lugar de confiar en el servidor para asignar uno.

Si target_id no es cero, no debe haber un objetivo activo existente en esta transmisión con la misma ID.

bool

Si el objetivo se elimina una vez que sea actual y consistente.

Int32Value

El número de documentos que coinciden por última vez en la consulta en el token de currículum o la hora de lectura.

Este valor solo es relevante cuando se proporciona un resume_type . Este valor está presente y mayor que cero señales de que el cliente quiere que ExistenceFilter.unchanged_names se incluya en la respuesta.

QueryTarget

Un objetivo especificado por una consulta.

DocumentsTarget

Un objetivo especificado por un conjunto de nombres de documentos.

bytes

Un token de currículum de un TargetChange anterior para un objetivo idéntico.

El uso de un token de currículum con un objetivo diferente no es compatible y puede fallar.

Timestamp

Comience a escuchar después de un read_time específica.

El cliente debe conocer el estado de los documentos coincidentes en este momento.

string

Los nombres de los documentos para recuperar. En el formato: projects/{project_id}/databases/{database_id}/documents/{document_path} . La solicitud fallará si alguno de los documentos no es un recurso infantil de la database dada. Los nombres duplicados serán eludidos.

string

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

StructuredQuery

Una consulta estructurada.

TargetChangeType

El tipo de cambio que ocurrió.

int32

Las ID de objetivo de los objetivos que han cambiado.

Si está vacío, el cambio se aplica a todos los objetivos.

El orden de los ID de destino no está definido.

Status

El error que resultó en este cambio, si corresponde.

bytes

Un token que se puede usar para reanudar la transmisión para los target_ids dados, o todos los objetivos si target_ids está vacío.

No se establece en cada cambio objetivo.

Timestamp

El read_time consistente para el target_ids dado (omitido cuando los Target_IDS no están en una instantánea consistente).

Se garantiza que la transmisión enviará un read_time con target_ids vacío cada vez que toda la transmisión alcanza una nueva instantánea consistente. Agregar, actualizar y restablecer los mensajes están garantizados (eventualmente) dar como resultado una nueva instantánea consistente (mientras que no_change y eliminar mensajes no lo son).

Para una transmisión determinada, se garantiza que read_time aumenta monotónicamente.

ReadOnly

La transacción solo se puede usar para operaciones de lectura.

ReadWrite

La transacción se puede usar tanto para operaciones de lectura como de escritura.

Timestamp

Lee documentos en el momento dado.

Debe ser una marca de tiempo con precisión de microsegundos dentro de la última hora o, si la recuperación de un punto en el tiempo está habilitada, también puede ser una marca de tiempo de un minuto completo dentro de los últimos 7 días.

bytes

Una transacción opcional para volver a intentarlo.

Document

Requerido. El documento actualizado. Crea el documento si aún no existe.

DocumentMask

Los campos para actualizar. Ninguna de las rutas de campo en la máscara puede contener un nombre reservado.

Si el documento existe en el servidor y tiene campos no mencionados en la máscara, se dejan sin cambios. Los campos a los que se hace referencia en la máscara, pero no presente en el documento de entrada, se eliminan del documento del servidor.

DocumentMask

Los campos para regresar. Si no está configurado, devuelve todos los campos.

Si el documento tiene un campo que no está presente en esta máscara, ese campo no se devolverá en la respuesta.

Precondition

Una condición previa opcional en el documento. La solicitud fallará si esto se establece y no se cumple con el documento de destino.

NullValue

Un valor nulo.

bool

Un valor booleano.

int64

Un valor entero.

double

Un valor doble.

Timestamp

Un valor de marca de tiempo.

Preciso solo a los microsegundos. Cuando se almacena, cualquier precisión adicional se redondea.

string

Un valor de cadena.

La cadena, representada como UTF -8, no debe exceder 1 MIB - 89 bytes. Solo los primeros 1.500 bytes de la representación UTF-8 son considerados por consultas.

bytes

Un valor de bytes.

No debe exceder 1 MIB - 89 bytes. Las consultas sólo consideran los primeros 1.500 bytes.

string

Una referencia a un documento. Por ejemplo: projects/{project_id}/databases/{database_id}/documents/{document_path} .

LatLng

Un valor de punto geo que representa un punto en la superficie de la tierra.

ArrayValue

Un valor de matriz.

No se puede contener directamente otro valor de matriz, aunque puede contener un mapa que contiene otra matriz.

MapValue

Un valor de mapa.

DocumentMask

Los campos para actualizar en esta escritura.

Este campo solo se puede configurar cuando se update la operación. Si la máscara no está configurada para una update y el documento existe, los datos existentes se sobrescribirán. Si la máscara está configurada y el documento en el servidor tiene campos no cubiertos por la máscara, se dejan sin cambios. Los campos a los que se hace referencia en la máscara, pero no presente en el documento de entrada, se eliminan del documento del servidor. Las rutas de campo en esta máscara no deben contener un nombre de campo reservado.

FieldTransform

Las transformaciones para realizar después de la actualización.

Este campo solo se puede configurar cuando se update la operación. Si está presente, esta escritura es equivalente a realizar update y transform en el mismo documento atómicamente y en orden.

Precondition

Una condición previa opcional en el documento.

La escritura fallará si esto se establece y no se cumple con el documento de destino.

Document

Un documento para escribir.

string

Un nombre de documento para eliminar. En el formato: projects/{project_id}/databases/{database_id}/documents/{document_path} .

DocumentTransform

Aplica una transformación a un documento.

string

Requerido. El nombre de la base de datos. En el formato: projects/{project_id}/databases/{database_id} . Esto solo se requiere en el primer mensaje.

string

La identificación de la transmisión de escritura para reanudar. Esto solo se puede configurar en el primer mensaje. Cuando se deje vacío, se creará una nueva transmisión de escritura.

Write

Las escrituras para aplicar.

Siempre ejecutado atómicamente y en orden. Esto debe estar vacío en la primera solicitud. Esto puede estar vacío en la última solicitud. Esto no debe estar vacío en todas las demás solicitudes.

bytes

Un token de transmisión que previamente fue enviado por el servidor.

El cliente debe establecer este campo en el token de WriteResponse más reciente que ha recibido. Esto reconoce que el cliente ha recibido respuestas a este token. Después de enviar esta token, los tokens anteriores ya no pueden usarse.

El servidor puede cerrar la transmisión si hay demasiadas respuestas no reconocidas.

Deje este campo sin crear una nueva transmisión. Para reanudar una transmisión en un punto específico, configure este campo y el campo stream_id .

Deje este campo sin crear una nueva transmisión.

map<string, string>

Etiquetas asociadas con esta solicitud de escritura.

string

La identificación de la corriente. Solo se establece en el primer mensaje, cuando se creó una nueva transmisión.

bytes

Un token que representa la posición de esta respuesta en la corriente. Esto puede ser utilizado por un cliente para reanudar la transmisión en este punto.

Este campo siempre está establecido.

WriteResult

El resultado de aplicar las escrituras.

Este resultado de escritura I-Th se corresponde a la escritura i-th en la solicitud.

Timestamp

El momento en que ocurrió el compromiso. Se garantiza que cualquier lectura con una read_time igual o mayor verá los efectos de la escritura.

Timestamp

La última hora de actualización del documento después de aplicar la escritura. No configurado después de un delete .

Si la escritura realmente no cambió el documento, este será el update_time anterior.

Value

Los resultados de aplicar cada DocumentTransform.FieldTransform , en el mismo orden.