Package google.firestore.v1beta1

map<string, Value>

El resultado de las funciones de agregación, p. ej.: 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 a la cantidad de funciones de agregación en la consulta.

Value

Valores del array.

string

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

string

Los nombres de los documentos que se recuperarán. 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 del database determinado. Se omitirán los nombres duplicados.

DocumentMask

Los campos que se mostrarán. Si no está configurado, muestra todos los campos.

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

bytes

Lee documentos de una transacción.

TransactionOptions

Inicia una nueva transacción y lee los documentos. La configuración predeterminada es una transacción de solo lectura. El nuevo ID de transacción se mostrará como la primera respuesta en la transmisión.

Timestamp

Lee los documentos tal como estaban en un momento determinado.

Debe ser una marca de tiempo con precisión de microsegundos dentro de la última hora o, si se habilitó la recuperación de un momento determinado, también puede ser una marca de tiempo de un minuto completo dentro de los últimos 7 días.

bytes

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

Timestamp

Indica la hora a la que se leyó el documento. Esto puede aumentar de forma monótona; en este caso, se garantiza que los documentos anteriores en la transmisión de resultados no hayan cambiado entre su read_time y esta.

Document

Un documento que se solicitó.

string

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

string

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

Write

Son las escrituras que se deben aplicar.

El método no aplica escrituras de forma atómica y no garantiza el orden. Cada escritura se realiza de manera correcta o falla de forma independiente. No puedes escribir en el mismo documento más de una vez por solicitud.

map<string, string>

Etiquetas asociadas con esta escritura por lotes.

WriteResult

El resultado de aplicar las escrituras.

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

Status

El estado de la aplicación de las escrituras.

Este estado de escritura i-ésima es la escritura i-ésima de la solicitud.

string

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

TransactionOptions

Son las opciones de la transacción. La configuración predeterminada es una transacción de lectura y escritura.

bytes

Es la transacción que se inició.

bytes

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

int32

La cantidad de bits del último byte de bitmap que se ignorarán como “padding”. Si la longitud de bitmap es cero, este valor debe ser 0. De lo contrario, este valor debe estar entre 0 y 7, inclusive.

BitSequence

Datos del filtro Bloom.

int32

La cantidad de hashes que usa el algoritmo.

string

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

Write

Son las escrituras que se deben aplicar.

Siempre se ejecuta de forma atómica y en orden.

bytes

Si se configura, aplica todas las operaciones de escritura en esta transacción y la confirma.

WriteResult

El resultado de aplicar las escrituras.

Este enésimo resultado de escritura corresponde a la escritura i-ésima de 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

Obligatorio. Es el recurso superior. Por ejemplo, projects/{project_id}/databases/{database_id}/documents o projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}.

string

Obligatorio. El ID de colección, en relación con parent, que se mostrará en la lista. Por ejemplo: chatrooms.

string

El ID de documento asignado por el cliente para usar en este documento.

Opcional. Si no se especifica, el servicio asignará un ID.

Document

Obligatorio. El documento que se creará. No se debe establecer name.

DocumentMask

Los campos que se mostrarán. Si no está configurado, muestra todos los campos.

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

Value

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

Puede contener menos valores de los especificados en la cláusula order by.

bool

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

string

Obligatorio. El nombre de recurso del documento que se borrará. 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 se configura y el documento de destino no lo cumple.

string

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

map<string, Value>

Timestamp

Solo salida. Indica la hora en la que se creó el documento.

Este valor aumenta de forma monotónica cuando se borra 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

Solo salida. Indica la hora en la que se modificó el documento por última vez.

Este valor se establece inicialmente en create_time y, luego, aumenta de forma monotónica 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 de Document.

Si estableces mask, contendrá solo los campos que se actualizaron o agregaron.

int32

Un conjunto de ID de destino de destinos que coinciden con este documento.

int32

Es un conjunto de ID de destino para destinos que ya no coinciden con este documento.

string

El nombre del recurso de Document que se borró.

int32

Un conjunto de ID de destino para los destinos que anteriormente coincidían con esta entidad.

Timestamp

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

Mayor o igual que el commit_time de la eliminación.

string

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

string

El nombre del recurso del Document que está fuera de vista.

int32

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

Timestamp

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

Mayor o igual que la commit_time del cambio, la eliminación o la eliminación.

string

El nombre del documento que se transformará.

FieldTransform

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

string

La ruta del campo. Consulta Document.fields para obtener la referencia de sintaxis de la ruta de acceso del campo.

ServerValue

Establece el campo en el valor del servidor determinado.

Value

Agrega el valor dado al valor actual del campo.

Debe ser un número entero o un valor 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 actual del campo se duplica, ambos valores se interpretarán como dobles. La aritmética doble y la representación de valores dobles siguen la semántica de IEEE 754. Si hay un desbordamiento de números enteros positivos o negativos, el campo se resuelve al número entero positivo/negativo de magnitud más grande.

Value

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

Debe ser un número entero o un valor 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 en la que el campo y el valor de entrada son de varios tipos (es decir, uno es un número entero y el otro es un doble), el campo adopta el tipo del operando más grande. Si los operandos son equivalentes (p.ej., 3 y 3.0), el campo no cambia. 0, 0.0 y -0.0 son cero. El máximo entre 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 especificado.

Debe ser un número entero o un valor 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 en la que el campo y el valor de entrada son tipos mixtos (es decir, uno es un número entero y el otro es un doble), el campo adopta el tipo del operando más pequeño. Si los operandos son equivalentes (p.ej., 3 y 3.0), el campo no cambia. 0, 0.0 y -0.0 son cero. El mínimo entre cero y un valor de entrada y cero es siempre el valor almacenado. El mínimo de cualquier valor numérico x y NaN es NaN.

ArrayValue

Agrega los elementos dados en orden si aún no están presentes en el valor del campo actual. Si el campo no es un array o si el campo aún no existe, primero se configura como un array vacío.

Los números equivalentes de diferentes tipos (p.ej., 3L y 3.0) se consideran iguales cuando se verifica si falta un valor. NaN es igual a NaN y Nulo es igual a Nulo. Si la entrada contiene múltiples valores equivalentes, solo se considerará el primero.

El transform_result correspondiente será el valor nulo.

ArrayValue

Quita todos los elementos especificados del array en el campo. Si el campo no es un array o si el campo aún no existe, se establece en el array vacío.

Los números equivalentes de los diferentes tipos (p.ej., 3L y 3.0) se consideran iguales para decidir si se debe quitar un elemento. NaN es igual a NaN y Nulo es igual a Nulo. Esto quitará todos los valores equivalentes si hay duplicados.

El transform_result correspondiente será el valor nulo.

int64

Cantidad total de resultados mostrados, incluidos documentos, proyecciones, resultados de agregación y claves.

Duration

Tiempo total para ejecutar la consulta en el backend.

int64

Total de operaciones de lectura facturables.

Struct

Estadísticas de depuración de la ejecución de la consulta. Ten en cuenta que las estadísticas de depuración están sujetas a cambios a medida que Firestore evoluciona. Puede incluir lo siguiente: { "indexes_inputs_s lujoso": "1000", "documents_spositive": "20", "billing_details" : { "documents_billable": "20", "index_entradas_billable": "1000", "min_query_cost": "0" }.

int32

El ID de destino al que se aplica este filtro.

int32

La cantidad total de documentos que coinciden con target_id.

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

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

BloomFilter

Un filtro de flor 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 flor se puede omitir a discreción del servidor, por ejemplo, si se considera que el cliente no lo utilizará o si su cálculo o transmisión es demasiado costoso en términos de procesamiento. Los clientes deben manejar correctamente la ausencia de este campo recurriendo a la lógica usada antes de que existiera el campo. es decir, volver a agregar el destino sin un token de reanudación para averiguar qué documentos de la caché del cliente no están sincronizados.

PlanSummary

Información de la fase de planificación para la consulta.

ExecutionStats

Estadísticas agregadas de la ejecución de la consulta. Solo está presente cuando ExplainOptions.analyze se establece como verdadero.

bool

Opcional. Indica si se debe ejecutar esta consulta.

Cuando es falso (el valor predeterminado), la consulta se planificará y mostrará solo las métricas de las etapas de planificación.

Cuando es verdadero, la consulta se planifica y ejecuta, y se muestran los resultados completos junto con las métricas de la etapa de planificación y ejecución.

string

Obligatorio. El nombre del recurso del documento que se obtendrá. En el formato projects/{project_id}/databases/{database_id}/documents/{document_path}.

DocumentMask

Los campos que se mostrarán. Si no está configurado, muestra todos los campos.

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

bytes

Lee el documento de una transacción.

Timestamp

Lee la versión del documento en un momento determinado.

Debe ser una marca de tiempo con precisión de microsegundos dentro de la última hora o, si se habilitó la recuperación de un momento determinado, también puede ser una marca de tiempo de un minuto completo dentro de los últimos 7 días.

string

Obligatorio. Es el documento superior. 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

La cantidad máxima de resultados que se mostrarán.

string

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

Timestamp

Lee los documentos tal como estaban en un momento determinado.

Debe ser una marca de tiempo con precisión de microsegundos dentro de la última hora o, si se habilitó la recuperación de un momento determinado, también puede ser una marca de tiempo de un minuto completo dentro de los últimos 7 días.

string

Los ID de colección.

string

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

string

Obligatorio. El nombre del recurso superior. Tiene 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 colección, en relación con parent, que se mostrará en la lista.

Por ejemplo, chatrooms o messages.

Esto es opcional y, cuando no se proporcione, Firestore mostrará una lista de los documentos de todas las colecciones en el parent proporcionado.

int32

Opcional. La cantidad máxima de documentos que se mostrarán en una sola respuesta.

Es posible que Firestore muestre menos que este valor.

string

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

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

string

Opcional. El orden opcional de los documentos que se mostrarán.

Por ejemplo: priority desc, __name__ desc.

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

DocumentMask

Opcional. Los campos que se mostrarán. Si no está configurado, muestra todos los campos.

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

bool

Si la lista debería mostrar documentos faltantes.

Falta un documento si no existe, pero hay subdocumentos anidados debajo. Si el valor es verdadero, los documentos faltantes se mostrarán con una clave, pero no tendrán configurados los campos create_time ni update_time.

Las solicitudes con show_missing no pueden especificar where ni order_by.

bytes

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

Timestamp

Realiza la lectura en el momento indicado.

Debe ser una marca de tiempo con precisión de microsegundos dentro de la última hora o, si se habilitó la recuperación de un momento determinado, 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 página siguiente de documentos.

Si se omite este campo, no habrá páginas siguientes.

string

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

map<string, string>

Las etiquetas asociadas con este destino cambian.

Target

Un destino para agregar a esta transmisión.

int32

El ID del destino que se quitará de esta transmisión.

TargetChange

Cambiaron los objetivos.

DocumentChange

Cambió una Document.

DocumentDelete

Se borró un Document.

DocumentRemove

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

ExistenceFilter

Un filtro que se aplica al conjunto de documentos que se mostró antes para el destino determinado.

Se muestra cuando es posible que los documentos se hayan quitado del destino determinado, pero se desconocen los documentos exactos.

map<string, Value>

Los campos del mapa.

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

string

Obligatorio. El nombre del recurso superior. En el formato projects/{project_id}/databases/{database_id}/documents. No se admiten los nombres de recursos de documentos. solo se pueden especificar nombres de recursos de base de datos.

int64

La cantidad máxima deseada de puntos de partición. Las particiones se pueden mostrar en varias páginas de resultados. El número debe ser positivo. La cantidad real de particiones que se muestran puede ser menor.

Por ejemplo, se puede establecer en uno menos que la cantidad de consultas paralelas que se ejecutarán o, en la ejecución de un trabajo de canalización de datos, en uno menos que la cantidad de trabajadores o instancias de procesamiento disponibles.

string

El valor next_page_token que se muestra en una llamada anterior a PartitionQuery que se puede usar para obtener un conjunto adicional de resultados. No hay garantías de orden entre conjuntos de resultados. Por lo tanto, para usar varios conjuntos de resultados, deberás combinarlos.

Por ejemplo, se pueden mostrar dos llamadas posteriores con un page_token:

• 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 suministrada a PartitionQuery, se deben combinar los conjuntos de resultados: cursor A, cursor B, cursor M, cursor Q, cursor U, cursor W

int32

La cantidad máxima de particiones que se mostrarán en esta llamada, sujeta a partition_count.

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

StructuredQuery

Una consulta estructurada. La consulta debe especificar la colección con todos los elementos subordinados y estar ordenada por nombre de forma ascendente. No se admiten otros filtros, ordenamientos por, límites, desplazamientos ni cursores de inicio/finalización.

Timestamp

Lee los documentos tal como estaban en un momento determinado.

Debe ser una marca de tiempo con precisión de microsegundos dentro de la última hora o, si se habilitó la recuperación de un momento determinado, también puede ser una marca de tiempo de un minuto completo dentro de los últimos 7 días.

Cursor

Particionar los resultados. Cada partición es un punto de división que puede usar RunQuery como punto de partida o de finalización para los resultados de la consulta. Las solicitudes RunQuery deben realizarse con la misma consulta suministrada a esta solicitud de PartitionQuery. Los cursores de partición se ordenarán de acuerdo con el mismo orden que los resultados de la consulta suministrada a PartitionQuery.

Por ejemplo, si una solicitud PartitionQuery muestra cursores de partición A y B, ejecutar las siguientes tres consultas mostrará todo el conjunto de resultados 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 aún no es compatible con la partición.

string

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

Struct

Los índices seleccionados para la consulta. Por ejemplo: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

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

Si se establece, el documento de destino debe existir y haber sido actualizado por última vez en ese momento. La marca de tiempo debe alinearse con microsegundos.

string

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

bytes

Obligatorio. La transacción que se revierte.

string

Obligatorio. El nombre del recurso superior. Tiene 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.

ExplainOptions

Opcional. Explicar las opciones para la consulta. Si se establece, se mostrarán estadísticas adicionales de las consultas. De lo contrario, solo se devolverán los resultados de la consulta.

StructuredAggregationQuery

Una consulta de agregación

bytes

Ejecutar la agregación dentro de una transacción ya activa

El valor aquí es el ID de transacción opaco en el que se ejecutará la consulta.

TransactionOptions

Inicia una nueva transacción como parte de la consulta y cambia la configuración predeterminada a solo lectura.

El nuevo ID de transacción se mostrará como la primera respuesta en la transmisión.

Timestamp

Ejecuta la consulta en la marca de tiempo especificada.

Debe ser una marca de tiempo con precisión de microsegundos dentro de la última hora o, si se habilitó la recuperación de un momento determinado, también puede ser una marca de tiempo de un minuto completo dentro de los últimos 7 días.

AggregationResult

Un solo resultado de agregación.

No está presente cuando se informa el progreso parcial.

bytes

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

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

Timestamp

El momento en que se calculó el resultado agregado. Esto siempre aumenta monótonamente; En este caso, se garantiza que el AggregationResult anterior en la transmisión de resultados no haya cambiado entre su read_time y este.

Si la consulta no muestra resultados, se enviará una respuesta con read_time y sin result, que representa la hora a la que se ejecutó la consulta.

ExplainMetrics

Métricas de explicación de consultas. Esto solo está presente cuando se proporciona el RunAggregationQueryRequest.explain_options y se envía solo una vez con la última respuesta de la transmisión.

string

Obligatorio. El nombre del recurso superior. Tiene 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.

ExplainOptions

Opcional. Explicar las opciones para la consulta. Si se establece, se mostrarán estadísticas adicionales de las consultas. De lo contrario, solo se devolverán los resultados de la consulta.

StructuredQuery

Una consulta estructurada.

bytes

Ejecutar la consulta dentro de una transacción ya activa

El valor aquí es el ID de transacción opaco en el que se ejecutará la consulta.

TransactionOptions

Inicia una nueva transacción y lee los documentos. La configuración predeterminada es una transacción de solo lectura. El nuevo ID de transacción se mostrará como la primera respuesta en la transmisión.

Timestamp

Lee los documentos tal como estaban en un momento determinado.

Debe ser una marca de tiempo con precisión de microsegundos dentro de la última hora o, si se habilitó la recuperación de un momento determinado, también puede ser una marca de tiempo de un minuto completo dentro de los últimos 7 días.

bytes

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

Document

Es un resultado de la consulta, no se establece cuando se informa el progreso parcial.

Timestamp

Indica la hora a la que se leyó el documento. Esto puede aumentar monótonamente; En este caso, se garantiza que los documentos anteriores del flujo de resultados no hayan cambiado entre su read_time y este.

Si la consulta no muestra resultados, se enviará una respuesta con read_time y sin document, que representa la hora a la que se ejecutó la consulta.

int32

La cantidad de resultados que se omitieron debido al desplazamiento entre la última respuesta y la respuesta actual.

ExplainMetrics

Métricas de explicación de consultas. Esto solo está presente cuando se proporciona el RunQueryRequest.explain_options y se envía solo una vez con la última respuesta de la transmisión.

bool

Si está presente, Firestore finalizó la solicitud por completo y no se mostrarán más documentos.

Aggregation

Opcional. Serie de agregaciones que se aplicarán a los resultados de structured_query

Requisitos:

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

StructuredQuery

Consulta estructurada anidada.

string

Opcional. Es el nombre opcional del campo en el que se almacenará el resultado de la agregación.

Si no se proporciona, Firestore elegirá un nombre predeterminado según 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 lo siguiente:

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 (
  ...
);

Requisitos:

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

Count

Agregador de recuento.

Sum

Agregador de suma.

Avg

Agregador promedio.

FieldReference

El campo en el que se realizará la agregación.

Int64Value

Opcional. Restricción opcional sobre la cantidad máxima de documentos que se deben contar.

Esto proporciona una forma de establecer un límite superior en la cantidad de documentos que se analizarán, lo que limita la latencia y el costo.

Si no se especifica, se interpreta como sin límite.

Ejemplo de alto nivel:

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

Requisitos:

• Debe ser mayor que cero cuando está presente.

FieldReference

El campo en el que se realizará la agregación.

Projection

Subconjunto opcional de los campos que se mostrarán.

Esto actúa como un DocumentMask sobre los documentos que se muestran en una consulta. Cuando no se establece, supone que el llamador desea que se devuelvan todos los campos.

CollectionSelector

Las colecciones que se consultarán.

Filter

El filtro que se aplicará.

Order

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

Firestore permite que los llamadores proporcionen un orden completo o parcial, o bien no proporcionar ningún orden. En todos los casos, Firestore garantiza un orden estable mediante las siguientes reglas:

• order_by es obligatorio para hacer referencia a todos los campos que se usan 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 orden lexicográfico del nombre del campo.
• Si no se especifica un pedido en __name__, se agrega de forma predeterminada.

A los campos se les agrega la misma dirección de orden que la del último orden especificado, o “ASCENDING”. si no se especificó ningún orden. Por ejemplo:

• ORDER BY a pasa a ser ORDER BY a ASC, __name__ ASC.
• ORDER BY a DESC pasa a ser ORDER BY a DESC, __name__ DESC.
• WHERE a > 1 pasa a ser WHERE a > 1 ORDER BY a ASC, __name__ ASC.
• WHERE __name__ > ... AND a > 1 pasa a ser WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC.

Cursor

Es un posible prefijo 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 del ORDER BY proporcionado.

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

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

A diferencia de OFFSET, que requiere analizar los primeros N resultados para omitirlos, un cursor de inicio permite que la consulta comience en una posición lógica. No es necesario que esta posición coincida con un resultado real, sino que escaneará hacia adelante desde esta posición para encontrar el siguiente documento.

Requisitos:

• La cantidad de valores no puede ser mayor que la cantidad de campos especificados en la cláusula ORDER BY.

Cursor

Un posible prefijo de una posición en el conjunto de resultados para finalizar la consulta.

Es similar a START_AT, pero controla la posición de finalización en lugar de la posición de inicio.

Requisitos:

• La cantidad de valores no puede ser mayor que la cantidad de campos especificados en la cláusula ORDER BY.

int32

Es la cantidad de documentos que se deben omitir antes de mostrar el primer resultado.

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

Requisitos:

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

Int32Value

La cantidad máxima de resultados que se mostrarán.

Se aplica después de todas las demás restricciones.

Requisitos:

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

FindNearest

Opcional. Una posible búsqueda de vecinos más cercanos.

Se aplica después de todos los demás filtros y orden.

Encuentra las incorporaciones vectoriales más cercanas al vector de consulta dado.

string

Es el ID de la colección. Cuando se establece, selecciona solo las colecciones con este ID.

bool

Cuando es falso, solo selecciona colecciones que sean elementos secundarios inmediatos del parent especificado en el RunQueryRequest que las contiene. Cuando es verdadero, selecciona todas las colecciones subordinadas.

Operator

Operador para combinar varios filtros.

Filter

Es la lista de filtros que se combinarán.

Requisitos:

• Hay al menos un filtro.

FieldReference

El campo que se usará para filtrar.

Operator

Operador por el que se debe filtrar.

Value

Valor con el que se va a comparar.

string

Es una referencia a un campo en un documento.

Requisitos:

• DEBE ser una cadena de segmentos delimitada por puntos (.), en la que cada segmento cumpla con las limitaciones de document field name.

CompositeFilter

Un filtro compuesto.

FieldFilter

Un filtro en el campo de un documento.

UnaryFilter

Un filtro que toma exactamente un argumento.

FieldReference

Obligatorio. Es un campo de vector indexado para buscar. Solo se pueden mostrar documentos que contienen vectores cuya dimensionalidad coincide con el vector_consulta.

Value

Obligatorio. El vector de consulta que estamos buscando. Debe ser un vector de no más de 2,048 dimensiones.

DistanceMeasure

Obligatorio. La medida de distancia que se usará, obligatoria.

Int32Value

Obligatorio. La cantidad de vecinos más cercanos que se mostrarán. Debe ser un número entero positivo de no más de 1,000.

FieldReference

El campo según el cual se debe realizar el pedido.

Direction

Indica las instrucciones para ordenar. La configuración predeterminada es ASCENDING.

FieldReference

Los campos que se mostrarán.

Si está vacío, se muestran todos los campos. Para mostrar solo el nombre del documento, usa ['__name__'].

Operator

El operador unario que se aplica.

FieldReference

El campo al que se aplica el operador.

int32

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

Si target_id es 0 (o no se especifica), el servidor asignará un ID para este destino y lo mostrará en un evento TargetChange::ADD. Una vez que se agrega un destino con target_id=0, todos los destinos 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 destino con target_id=0, el servidor enviará inmediatamente una respuesta con un evento TargetChange::Remove.

Ten en cuenta que, si el cliente envía varias solicitudes AddTarget sin un ID, el orden de los ID que se muestran en TargetChage.target_ids no está definido. Por lo tanto, los clientes deben proporcionar un ID de destino en lugar de depender del servidor para asignar uno.

Si target_id no es cero, no debe haber ningún objetivo activo en esta transmisión con el mismo ID.

bool

Si el objetivo debe quitarse una vez que esté actualizado y sea coherente.

Int32Value

La cantidad de documentos que coincidieron por última vez con la consulta en el token de reanudación o en el momento de la lectura.

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

QueryTarget

Un objetivo especificado por una consulta.

DocumentsTarget

Es un objetivo especificado por un conjunto de nombres de documentos.

bytes

Un token de reanudación de un TargetChange anterior para un destino idéntico.

No se admite el uso de un token de reanudación con un destino diferente y es posible que falle.

Timestamp

Comienza a escuchar después de un read_time específico.

En este momento, el cliente debe conocer el estado de los documentos coincidentes.

string

Los nombres de los documentos que se recuperarán. 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 del database determinado. Se omitirán los nombres duplicados.

string

El nombre del recurso superior. Tiene 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 se produjo.

int32

Los ID de destino de las orientaciones que cambiaron.

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 generó este cambio, si corresponde.

bytes

Un token que se puede usar para reanudar la transmisión del target_ids determinado o todos los destinos si target_ids está vacío.

No se estableció en todos los cambios de objetivos.

Timestamp

El read_time coherente para el target_ids especificado (se omite cuando los target_ids no están en una instantánea coherente)

Se garantiza que la transmisión envíe un read_time con target_ids vacío cada vez que toda la transmisión alcanza una nueva instantánea coherente. Se garantiza que los mensajes ADD, CURRENT y RESET generarán (en algún momento) una nueva instantánea coherente (mientras que los mensajes NO_CHANGE y REMOVE no lo son).

Para una transmisión determinada, se garantiza que read_time aumentará monótonamente.

ReadOnly

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

ReadWrite

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

Timestamp

Lee documentos en un momento determinado.

Debe ser una marca de tiempo con precisión de microsegundos dentro de la última hora o, si se habilitó la recuperación de un momento determinado, 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

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

DocumentMask

Los campos que se actualizarán. Ninguna de las rutas de campo de la máscara puede contener un nombre reservado.

Si el documento existe en el servidor y tiene campos a los que no se hace referencia en la máscara, estos no se modifican. Los campos a los que se hace referencia en la máscara, pero que no están presentes en el documento de entrada, se borran del documento en el servidor.

DocumentMask

Los campos que se mostrarán. Si no está configurado, muestra todos los campos.

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

Precondition

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

NullValue

Un valor nulo.

bool

Un valor booleano

int64

Es un valor entero.

double

Un valor doble.

Timestamp

Un valor de marca de tiempo.

Precisa solo en microsegundos. Cuando se almacena, cualquier precisión adicional se redondea hacia abajo.

string

Es un valor de cadena.

La cadena, representada como UTF-8, no debe exceder 1 MiB a 89 bytes. Las consultas solo consideran los primeros 1,500 bytes de la representación UTF-8.

bytes

Es un valor de bytes.

No debe superar los 1 MiB a 89 bytes. Las consultas solo consideran los primeros 1,500 bytes.

string

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

LatLng

Es un valor de punto geográfico que representa un punto de la superficie de la Tierra.

ArrayValue

Es un valor de array.

No puede contener directamente otro valor de array, aunque puede contener un mapa que contenga otro array.

MapValue

Es un valor de mapa.

DocumentMask

Los campos que se actualizarán en esta escritura.

Este campo se puede configurar solo cuando la operación es update. Si no se configura la máscara para un update y el documento existe, se reemplazarán los datos existentes. Si la máscara está configurada y el documento en el servidor tiene campos que no están cubiertos por la máscara, estos no se modifican. Los campos a los que se hace referencia en la máscara, pero que no están presentes en el documento de entrada, se borran del documento en el servidor. Las rutas de campo de esta máscara no deben contener un nombre de campo reservado.

FieldTransform

Las transformaciones que se realizarán después de la actualización.

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

Precondition

Una condición previa opcional en el documento.

La escritura fallará si se configura y el documento de destino no la cumple.

Document

Un documento para escribir.

string

El nombre de un documento que se borrará. En el formato projects/{project_id}/databases/{database_id}/documents/{document_path}.

DocumentTransform

Aplica una transformación a un documento.

string

Obligatorio. El nombre de la base de datos. En el formato projects/{project_id}/databases/{database_id}. Este paso solo es obligatorio en el primer mensaje.

string

El ID de la transmisión de escritura que se reanudará. Esta opción solo se puede configurar en el primer mensaje. Si se deja vacío, se creará un flujo de escritura nuevo.

Write

Son las escrituras que se deben aplicar.

Siempre se ejecuta de forma atómica y en orden. Debe estar vacío en la primera solicitud. Puede estar vacío en la última solicitud. No debe estar vacío en todas las demás solicitudes.

bytes

Un token de transmisión que el servidor envió anteriormente.

El cliente debe configurar este campo en el token del WriteResponse más reciente que recibió. Esto confirma que el cliente recibió respuestas hasta este token. Después de enviar este token, es posible que ya no se usen los anteriores.

Es posible que el servidor cierre la transmisión si hay demasiadas respuestas sin confirmar.

No configures este campo cuando crees una nueva transmisión. Para reanudar una transmisión en un punto específico, configura este campo y el campo stream_id.

No configures este campo cuando crees una transmisión nueva.

map<string, string>

Son las etiquetas asociadas con esta solicitud de escritura.

string

El ID de la transmisión. Solo se establece en el primer mensaje, cuando se crea una nueva transmisión.

bytes

Es un token que representa la posición de esta respuesta en la transmisión. Un cliente puede usarlo para reanudar la transmisión en este punto.

Este campo siempre está configurado.

WriteResult

El resultado de aplicar las escrituras.

Este enésimo resultado de escritura corresponde a la escritura i-ésima de 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 escritura.

Timestamp

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

Si la operación de escritura no cambió realmente el documento, esta será la hora de actualización anterior.

Value

Los resultados de la aplicación de cada DocumentTransform.FieldTransform, en el mismo orden.