Package google.firestore.v1beta1

map<string, Value>

Résultat des fonctions d'agrégation, par exemple: COUNT(*) AS total_docs.

La clé est la alias attribuée à la fonction d'agrégation en entrée. La taille de ce mappage est égale au nombre de fonctions d'agrégation dans la requête.

Value

Valeurs du tableau.

string

Obligatoire. Nom de la base de données. Format à respecter: projects/{project_id}/databases/{database_id}.

string

Noms des documents à récupérer. Format à respecter: projects/{project_id}/databases/{database_id}/documents/{document_path}. La requête échoue si l'un des documents n'est pas une ressource enfant de l'élément database donné. Les noms en double sont supprimés.

DocumentMask

Champs à renvoyer. Si ce champ n'est pas spécifié, tous les champs sont renvoyés.

Si un document comporte un champ qui n'est pas présent dans ce masque, ce champ n'est pas renvoyé dans la réponse.

bytes

Lit les documents d'une transaction.

TransactionOptions

Démarre une nouvelle transaction et lit les documents. La valeur par défaut est une transaction en lecture seule. Le nouvel ID de transaction est renvoyé en tant que première réponse dans le flux.

Timestamp

Lit les documents tels qu'ils étaient à l'époque.

Il doit s'agir d'un horodatage de précision de l'ordre de la microseconde au cours de la dernière heure. Si la récupération à un moment précis est activée, il peut également s'agir d'un horodatage d'une minute entière datant des sept derniers jours.

bytes

Transaction démarrée dans le cadre de cette requête. Ne sera défini que dans la première réponse, et uniquement si BatchGetDocumentsRequest.new_transaction a été défini dans la requête.

Timestamp

Heure à laquelle le document a été lu. Cette valeur peut augmenter de façon linéaire. Dans ce cas, il est garanti que les documents précédents dans le flux de résultats n'ont pas changé entre leur valeur read_time et celui-ci.

Document

Un document demandé.

string

Nom de document demandé, mais qui n'existe pas. Format à respecter: projects/{project_id}/databases/{database_id}/documents/{document_path}.

string

Obligatoire. Nom de la base de données. Format à respecter: projects/{project_id}/databases/{database_id}.

Write

Écritures à appliquer.

La méthode n'applique pas les écritures de manière atomique et ne garantit pas l'ordre. Chaque écriture réussit ou échoue indépendamment. Vous ne pouvez pas écrire dans le même document plusieurs fois par requête.

map<string, string>

Étiquettes associées à cette écriture par lot.

WriteResult

Résultat de l'application des écritures.

Cette i-ième écriture correspond à l'i-ième écriture de la requête.

Status

État de l'application des écritures.

Cet état d'écriture i-ième correspond à l'écriture i-ième dans la requête.

string

Obligatoire. Nom de la base de données. Format à respecter: projects/{project_id}/databases/{database_id}.

TransactionOptions

Options de la transaction. La valeur par défaut est une transaction en lecture-écriture.

bytes

Transaction qui a démarré.

bytes

Octets qui encodent la séquence de bits. Peut avoir une longueur égale à zéro.

int32

Nombre de bits du dernier octet dans bitmap à ignorer en tant que "remplissage". Si la longueur de bitmap est de zéro, cette valeur doit être 0. Sinon, cette valeur doit être comprise entre 0 et 7 inclus.

BitSequence

Données du filtre de fleur.

int32

Nombre de hachages utilisés par l'algorithme.

string

Obligatoire. Nom de la base de données. Format à respecter: projects/{project_id}/databases/{database_id}.

Write

Écritures à appliquer.

Toujours exécuté de manière atomique et dans l'ordre.

bytes

Si cette option est définie, elle applique toutes les écritures de cette transaction et la valide.

WriteResult

Résultat de l'application des écritures.

Cette i-ième écriture correspond à l'i-ième écriture de la requête.

Timestamp

Heure à laquelle le commit a été effectué. Toute lecture avec un read_time égal ou supérieur affiche les effets du commit.

string

Obligatoire. Ressource parente. (par exemple, projects/{project_id}/databases/{database_id}/documents ou projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}).

string

Obligatoire. ID de collection de la liste (par rapport à parent). Exemple : chatrooms.

string

ID de document attribué par le client à utiliser pour ce document.

Facultatif. S'il n'est pas spécifié, un identifiant sera attribué par le service.

Document

Obligatoire. Document à créer. name ne doit pas être défini.

DocumentMask

Champs à renvoyer. Si ce champ n'est pas spécifié, tous les champs sont renvoyés.

Si le document comporte un champ qui n'est pas présent dans ce masque, il ne sera pas renvoyé dans la réponse.

Value

Valeurs qui représentent une position, dans l'ordre dans lequel elles apparaissent dans la clause ordre par clause d'une requête.

Peut contenir moins de valeurs que celles spécifiées dans la clause "order by".

bool

Si la position est juste avant ou juste après les valeurs données, par rapport à l'ordre de tri défini par la requête.

string

Obligatoire. Nom de ressource du document à supprimer. Format à respecter: projects/{project_id}/databases/{database_id}/documents/{document_path}.

Precondition

Une condition préalable facultative sur le document. La requête échoue si ce champ est défini et que le document cible n'y répond pas.

string

Nom de ressource du document (par exemple, projects/{project_id}/databases/{database_id}/documents/{document_path}).

map<string, Value>

Timestamp

Uniquement en sortie. Heure à laquelle le document a été créé.

Cette valeur augmente de façon linéaire lorsqu'un document est supprimé, puis recréé. Il peut également être comparé aux valeurs d'autres documents et aux read_time d'une requête.

Timestamp

Uniquement en sortie. Heure à laquelle le document a été modifié pour la dernière fois.

Cette valeur est initialement définie sur create_time, puis augmente de façon linéaire à chaque modification du document. Il peut également être comparé aux valeurs d'autres documents et aux read_time d'une requête.

Document

Nouvel état de Document.

Si mask est défini, ne contient que les champs qui ont été mis à jour ou ajoutés.

int32

Un ensemble d'ID de cibles correspondant à ce document.

int32

Un ensemble d'ID de cibles pour les cibles qui ne correspondent plus à ce document.

string

Nom de la ressource Document qui a été supprimée.

int32

Un ensemble d'ID cibles pour les cibles qui correspondaient précédemment à cette entité.

Timestamp

Horodatage de lecture correspondant à la suppression.

Supérieur ou égal à la valeur commit_time de la suppression.

string

Liste des chemins d'accès des champs dans le masque. Pour obtenir une documentation de référence sur la syntaxe des chemins d'accès à un champ, consultez Document.fields.

string

Nom de la ressource Document qui n'est plus visible.

int32

Un ensemble d'ID cibles pour les cibles qui correspondaient précédemment à ce document.

Timestamp

Horodatage de lecture correspondant au moment où la suppression a été observée.

Supérieur ou égal à la valeur de commit_time de la modification, de la suppression ou de la suppression.

string

Nom du document à transformer.

FieldTransform

Liste des transformations à appliquer aux champs du document, dans l'ordre. Ce champ est obligatoire.

string

Chemin d'accès du champ. Consultez Document.fields pour obtenir des informations de référence sur la syntaxe des chemins d'accès au champ.

ServerValue

Définit le champ sur la valeur de serveur indiquée.

Value

Ajoute la valeur donnée à la valeur actuelle du champ.

Il doit s'agir d'un nombre entier ou d'une valeur double. Si le champ n'est pas un nombre entier ou double, ou si le champ n'existe pas encore, la transformation définira le champ sur la valeur donnée. Si la valeur donnée ou la valeur actuelle du champ sont des doubles, les deux valeurs seront interprétées comme des doubles. La double arithmétique et la représentation des valeurs doubles suivent la sémantique IEEE 754. En cas de dépassement d'entiers positifs/négatifs, le champ est résolu au plus grand nombre entier positif/négatif.

Value

Définit le champ sur la valeur maximale de sa valeur actuelle et de la valeur donnée.

Il doit s'agir d'un nombre entier ou d'une valeur double. Si le champ n'est pas un nombre entier ou double, ou si le champ n'existe pas encore, la transformation définira le champ sur la valeur donnée. Si une opération maximale est appliquée lorsque le champ et la valeur d'entrée sont de types mixtes (c'est-à-dire que l'un est un entier et l'autre un double), le champ prend le type de l'opérande le plus grand. Si les opérandes sont équivalents (par exemple, 3 et 3.0), le champ ne change pas. 0, 0,0 et -0,0 sont tous nuls. Le maximum d'une valeur stockée nulle et d'une valeur d'entrée égale à zéro correspond toujours à la valeur stockée. Le maximum de toute valeur numérique x et NaN est NaN.

Value

Définit le champ sur la valeur minimale de sa valeur actuelle et de la valeur donnée.

Il doit s'agir d'un nombre entier ou d'une valeur double. Si le champ n'est pas un nombre entier ni un nombre double, ou si le champ n'existe pas encore, la transformation définira le champ sur la valeur d'entrée. Si une opération minimale est appliquée lorsque le champ et la valeur d'entrée sont de types mixtes (c'est-à-dire, un est un entier et un est un double), le champ prend le type du plus petit opérande. Si les opérandes sont équivalents (par exemple, 3 et 3.0), le champ ne change pas. 0, 0,0 et -0,0 sont tous nuls. La valeur stockée minimale et la valeur d'entrée nulle sont toujours égales à la valeur stockée. Le minimum de toute valeur numérique x et NaN est NaN.

ArrayValue

Permet d'ajouter les éléments indiqués dans l'ordre s'ils ne sont pas déjà présents dans la valeur actuelle du champ. Si le champ n'est pas un tableau ou s'il n'existe pas encore, il est d'abord défini sur le tableau vide.

Les nombres équivalents de différents types (par exemple, 3L et 3,0) sont considérés comme égaux lorsque vous vérifiez s'il manque une valeur. NaN est égal à NaN, et Null est égal à Null. Si l'entrée contient plusieurs valeurs équivalentes, seule la première sera prise en compte.

Le résultat transform_result correspondant sera la valeur nulle.

ArrayValue

Supprimez tous les éléments indiqués du tableau du champ. Si le champ n'est pas un tableau ou s'il n'existe pas encore, il est défini sur le tableau vide.

Les nombres équivalents des différents types (par exemple, 3L et 3,0) sont considérés comme égaux au moment de décider si un élément doit être supprimé. NaN est égal à NaN, et Null est égal à Null. Cela supprimera toutes les valeurs équivalentes s'il y a des doublons.

Le résultat transform_result correspondant sera la valeur nulle.

int64

Nombre total de résultats renvoyés, y compris les documents, les projections, les résultats d'agrégation et les clés.

Duration

Durée totale d'exécution de la requête dans le backend.

int64

Nombre total d'opérations de lecture facturables.

Struct

Déboguer les statistiques de l'exécution de la requête Notez que les statistiques de débogage sont susceptibles de changer à mesure que Firestore évolue. It could include: { "indexes_entries_scanned": "1000", "documents_scanned": "20", "billing_details" : { "documents_billable": "20", "index_entries_billable": "1000", "min_query_cost": "0" } }

int32

ID de la cible à laquelle s'applique ce filtre.

int32

Nombre total de documents correspondant à target_id.

S'il est différent du nombre de documents du client qui correspondent, le client doit déterminer manuellement ceux qui ne correspondent plus à la cible.

Le client peut utiliser le filtre "Bloom" unchanged_names pour faciliter cette identification en testant TOUS les noms de documents par rapport au filtre. Si le nom du document NE figure PAS dans le filtre, cela signifie que le document ne correspond plus à la cible.

BloomFilter

Filtre de Bloom qui, malgré son nom, contient les encodages d'octets UTF-8 des noms de ressources de TOUS les documents correspondant à target_id, sous la forme projects/{project_id}/databases/{database_id}/documents/{document_path}.

Ce filtre de Bloom peut être omis à la discrétion du serveur, par exemple s'il est considéré que le client ne l'utilisera pas ou s'il est trop coûteux en calcul à calculer ou à transmettre. Les clients doivent gérer correctement l'absence de ce champ en revenant à la logique utilisée avant l'existence de ce champ, c'est-à-dire qu'ils doivent rajouter la cible sans jeton de CV pour déterminer quels documents dans le cache du client sont désynchronisés.

PlanSummary

Informations sur la phase de planification de la requête.

ExecutionStats

Statistiques agrégées de l'exécution de la requête. Uniquement présente lorsque ExplainOptions.analyze est défini sur "true".

bool

Facultatif. Indique si cette requête doit être exécutée.

Si la valeur est "false" (valeur par défaut), la requête est planifiée et ne renvoie que les métriques des étapes de planification.

Si la valeur est "true", la requête est planifiée et exécutée, et elle renvoie les résultats complets de la requête, ainsi que les métriques des étapes de planification et d'exécution.

string

Obligatoire. Nom de ressource du document à récupérer. Format à respecter: projects/{project_id}/databases/{database_id}/documents/{document_path}.

DocumentMask

Champs à renvoyer. Si ce champ n'est pas spécifié, tous les champs sont renvoyés.

Si le document comporte un champ qui n'est pas présent dans ce masque, il ne sera pas renvoyé dans la réponse.

bytes

Lit le document dans une transaction.

Timestamp

Lit la version du document à l'heure donnée.

Il doit s'agir d'un horodatage de précision de l'ordre de la microseconde au cours de la dernière heure. Si la récupération à un moment précis est activée, il peut également s'agir d'un horodatage d'une minute entière datant des sept derniers jours.

string

Obligatoire. Document parent. Format à respecter: projects/{project_id}/databases/{database_id}/documents/{document_path}. Par exemple : projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

int32

Nombre maximal de résultats à renvoyer.

string

Un jeton de page. Doit être une valeur de ListCollectionIdsResponse.

Timestamp

Lit les documents tels qu'ils étaient à l'époque.

Il doit s'agir d'un horodatage de précision de l'ordre de la microseconde au cours de la dernière heure. Si la récupération à un moment précis est activée, il peut également s'agir d'un horodatage d'une minute entière datant des sept derniers jours.

string

ID des collections.

string

Jeton de page qui peut être utilisé pour poursuivre la liste.

string

Obligatoire. Nom de la ressource parente. Format à respecter: projects/{project_id}/databases/{database_id}/documents ou projects/{project_id}/databases/{database_id}/documents/{document_path}.

(par exemple, projects/my-project/databases/my-database/documents ou projects/my-project/databases/my-database/documents/chatrooms/my-chatroom).

string

Facultatif. ID de collection de la liste (par rapport à parent).

Par exemple, chatrooms ou messages.

Cette option est facultative. Lorsqu'elle n'est pas fournie, Firestore affiche les documents de toutes les collections dans le parent fourni.

int32

Facultatif. Nombre maximal de documents à renvoyer par réponse.

Firestore peut renvoyer une valeur inférieure à cette valeur.

string

Facultatif. Jeton de page, provenant d'une réponse ListDocuments précédente.

Fournissez-le pour récupérer la page suivante. Lors de la pagination, tous les autres paramètres (à l'exception de page_size) doivent correspondre aux valeurs définies dans la requête qui a généré le jeton de page.

string

Facultatif. Ordre facultatif des documents à renvoyer.

Exemple : priority desc, __name__ desc.

Cette valeur reflète la valeur ORDER BY utilisée dans les requêtes Firestore, mais sous la forme d'une représentation sous forme de chaîne. Si ce champ n'est pas renseigné, les documents sont classés en fonction de __name__ ASC.

DocumentMask

Facultatif. Champs à renvoyer. Si ce champ n'est pas spécifié, tous les champs sont renvoyés.

Si un document comporte un champ qui n'est pas présent dans ce masque, ce champ n'est pas renvoyé dans la réponse.

bool

Si la liste doit afficher des documents manquants

Un document est manquant s'il n'existe pas, mais des sous-documents sont imbriqués sous celui-ci. Lorsque la valeur est "true", ces documents manquants sont renvoyés avec une clé, mais sans champs, create_time ni update_time définis.

Les requêtes avec show_missing ne peuvent pas spécifier where ni order_by.

bytes

Effectuez la lecture dans le cadre d'une transaction déjà active.

Timestamp

Effectuez la lecture au moment indiqué.

Il doit s'agir d'un horodatage de précision de l'ordre de la microseconde au cours de la dernière heure. Si la récupération à un moment précis est activée, il peut également s'agir d'un horodatage d'une minute entière datant des sept derniers jours.

Document

Documents trouvés.

string

Jeton permettant de récupérer la page de documents suivante.

Si ce champ est omis, il n'y a pas d'autres pages.

string

Obligatoire. Nom de la base de données. Format à respecter: projects/{project_id}/databases/{database_id}.

map<string, string>

Étiquettes associées à cette modification de cible.

Target

Cible à ajouter à ce flux.

int32

ID d'une cible à supprimer de ce flux.

TargetChange

Les cibles ont changé.

DocumentChange

Document a été modifié.

DocumentDelete

Un(e) Document a été supprimé(e).

DocumentRemove

Un élément Document a été supprimé d'une cible (car il n'est plus pertinent pour cette cible).

ExistenceFilter

Filtre à appliquer à l'ensemble de documents précédemment renvoyés pour la cible donnée.

Est renvoyé lorsque des documents ont peut-être été supprimés de la cible donnée, mais que les documents exacts sont inconnus.

map<string, Value>

Champs de la carte

Les clés de mappage représentent des noms de champs. Les noms de champs correspondant à l'expression régulière __.*__ sont réservés. Les noms de champs réservés sont interdits, sauf dans certains contextes documentés. Les clés de mappage, représentées au format UTF-8, ne doivent pas dépasser 1 500 octets et ne peuvent pas être vides.

string

Obligatoire. Nom de la ressource parente. Format à respecter: projects/{project_id}/databases/{database_id}/documents. Les noms de ressources de document ne sont pas compatibles. Seuls les noms de ressources de base de données peuvent être spécifiés.

int64

Nombre maximal de points de partition souhaité. Les partitions peuvent être renvoyées sur plusieurs pages de résultats. Le nombre doit être positif. Le nombre réel de partitions renvoyées peut être inférieur.

Par exemple, elle peut être définie sur un de moins que le nombre de requêtes parallèles à exécuter, ou, dans le cas de l'exécution d'un job de pipeline de données, sur un de moins que le nombre de nœuds de calcul ou d'instances de calcul disponibles.

string

Valeur next_page_token renvoyée par un appel précédent à PartitionQuery, qui peut être utilisée pour obtenir un ensemble supplémentaire de résultats. Il n'existe aucune garantie de classement entre les ensembles de résultats. Par conséquent, l'utilisation de plusieurs ensembles de résultats nécessite la fusion des différents ensembles.

Par exemple, deux appels suivants utilisant un jeton page_token peuvent renvoyer:

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

Pour obtenir un ensemble de résultats complet ordonné par rapport aux résultats de la requête fournie à PartitionQuery, vous devez fusionner les ensembles de résultats: curseur A, curseur B, curseur M, curseur Q, curseur U, curseur W

int32

Nombre maximal de partitions à renvoyer dans cet appel, sous réserve de partition_count.

Par exemple, si partition_count = 10 et page_size = 8, le premier appel à PartitionQuery renvoie jusqu'à 8 partitions et un next_page_token s'il existe d'autres résultats. Un deuxième appel à PartitionQuery renvoie jusqu'à 2 partitions pour effectuer les 10 partitions spécifiées dans partition_count.

StructuredQuery

Une requête structurée La requête doit spécifier une collection avec tous les descendants et être classée par ordre croissant de nom. Les autres filtres, tris, limites, décalages et curseurs de début/fin ne sont pas acceptés.

Timestamp

Lit les documents tels qu'ils étaient à l'époque.

Il doit s'agir d'un horodatage de précision de l'ordre de la microseconde au cours de la dernière heure. Si la récupération à un moment précis est activée, il peut également s'agir d'un horodatage d'une minute entière datant des sept derniers jours.

Cursor

Partitionner les résultats. Chaque partition est un point de division que RunQuery peut utiliser comme point de départ ou d'arrivée pour les résultats de la requête. Les requêtes RunQuery doivent être effectuées avec la même requête fournie à cette requête PartitionQuery. Les curseurs de partition seront classés dans le même ordre que les résultats de la requête fournie à PartitionQuery.

Par exemple, si une requête PartitionQuery renvoie les curseurs de partition A et B, l'exécution des trois requêtes suivantes renvoie l'ensemble de résultats complet de la requête d'origine:

• requête, fin_à A
• requête, commencer_à_A, fin_à_B
• requête, démarrer_à_B

Un résultat vide peut indiquer que la requête a trop peu de résultats pour être partitionnée ou qu'elle n'est pas encore prise en charge pour le partitionnement.

string

Jeton de page pouvant être utilisé pour demander un ensemble de résultats supplémentaire, jusqu'au nombre spécifié par partition_count dans la requête PartitionQuery. Si ce champ est vide, il n'y a plus de résultats.

Struct

Index sélectionnés pour la requête For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

bool

Si ce paramètre est défini sur true, le document cible doit exister. Si ce paramètre est défini sur false, le document cible ne doit pas exister.

Timestamp

Lorsque ce champ est défini, le document cible doit exister et avoir été mis à jour pour la dernière fois à cette date. Le code temporel doit être aligné en microsecondes.

string

Obligatoire. Nom de la base de données. Format à respecter: projects/{project_id}/databases/{database_id}.

bytes

Obligatoire. Transaction à annuler.

string

Obligatoire. Nom de la ressource parente. Format à respecter: projects/{project_id}/databases/{database_id}/documents ou projects/{project_id}/databases/{database_id}/documents/{document_path}. Par exemple: projects/my-project/databases/my-database/documents ou projects/my-project/databases/my-database/documents/chatrooms/my-chatroom.

ExplainOptions

Facultatif. Expliquez les options de la requête. Si cette option est définie, des statistiques de requête supplémentaires sont renvoyées. Si ce n'est pas le cas, seuls les résultats de la requête seront renvoyés.

StructuredAggregationQuery

Une requête d'agrégation.

bytes

Exécutez l'agrégation dans une transaction déjà active.

La valeur ici est l'ID de transaction opaque dans lequel exécuter la requête.

TransactionOptions

Démarre une nouvelle transaction dans le cadre de la requête, en lecture seule par défaut.

Le nouvel ID de transaction est renvoyé en tant que première réponse dans le flux.

Timestamp

Exécute la requête à l'horodatage donné.

Il doit s'agir d'un horodatage de précision de l'ordre de la microseconde au cours de la dernière heure. Si la récupération à un moment précis est activée, il peut également s'agir d'un horodatage d'une minute entière datant des sept derniers jours.

AggregationResult

Résultat d'agrégation unique.

Indisponible lorsque vous signalez une progression partielle.

bytes

Transaction démarrée dans le cadre de cette requête.

Présent uniquement dans la première réponse lorsque la requête a demandé le lancement d'une nouvelle transaction.

Timestamp

Heure à laquelle le résultat agrégé a été calculé. Ce nombre augmente toujours de manière monotone. Dans ce cas, il est garanti que l'élément AggregationResult précédent dans le flux de résultats n'a pas changé entre leur read_time et celui-ci.

Si la requête ne renvoie aucun résultat, une réponse contenant read_time et aucun result sera envoyée, ce qui représente l'heure à laquelle la requête a été exécutée.

ExplainMetrics

Métriques d'explication des requêtes. Il n'est présent que lorsque le RunAggregationQueryRequest.explain_options est fourni. Il n'est envoyé qu'une seule fois avec la dernière réponse du flux.

string

Obligatoire. Nom de la ressource parente. Format à respecter: projects/{project_id}/databases/{database_id}/documents ou projects/{project_id}/databases/{database_id}/documents/{document_path}. Par exemple: projects/my-project/databases/my-database/documents ou projects/my-project/databases/my-database/documents/chatrooms/my-chatroom.

ExplainOptions

Facultatif. Expliquez les options de la requête. Si cette option est définie, des statistiques de requête supplémentaires sont renvoyées. Si ce n'est pas le cas, seuls les résultats de la requête seront renvoyés.

StructuredQuery

Une requête structurée

bytes

Exécutez la requête dans une transaction déjà active.

La valeur ici est l'ID de transaction opaque dans lequel exécuter la requête.

TransactionOptions

Démarre une nouvelle transaction et lit les documents. La valeur par défaut est une transaction en lecture seule. Le nouvel ID de transaction est renvoyé en tant que première réponse dans le flux.

Timestamp

Lit les documents tels qu'ils étaient à l'époque.

Il doit s'agir d'un horodatage de précision de l'ordre de la microseconde au cours de la dernière heure. Si la récupération à un moment précis est activée, il peut également s'agir d'un horodatage d'une minute entière datant des sept derniers jours.

bytes

Transaction démarrée dans le cadre de cette requête. Ne peut être défini que dans la première réponse, et uniquement si RunQueryRequest.new_transaction a été défini dans la requête. Si cette valeur est définie, aucun autre champ ne sera défini dans cette réponse.

Document

Résultat de requête non défini lors de la création de rapports sur une progression partielle.

Timestamp

Heure à laquelle le document a été lu. L'augmentation peut être monotone. Dans ce cas, il est garanti que les documents précédents dans le flux de résultats n'ont pas changé entre leur read_time et celui-ci.

Si la requête ne renvoie aucun résultat, une réponse contenant read_time et aucun document sera envoyée, ce qui représente l'heure à laquelle la requête a été exécutée.

int32

Nombre de résultats ignorés en raison d'un décalage entre la dernière réponse et la réponse actuelle.

ExplainMetrics

Métriques d'explication des requêtes. Il n'est présent que lorsque le RunQueryRequest.explain_options est fourni. Il n'est envoyé qu'une seule fois avec la dernière réponse du flux.

bool

S'il est présent, Firestore a complètement finalisé la requête, et aucun autre document ne sera renvoyé.

Aggregation

Facultatif. Série d'agrégations à appliquer aux résultats de structured_query.

Configuration requise:

• Un minimum d'une et un maximum de cinq agrégations par requête.

StructuredQuery

Requête structurée imbriquée.

string

Facultatif. Nom facultatif du champ dans lequel stocker le résultat de l'agrégation.

Si ce champ n'est pas fourni, Firestore choisit un nom par défaut au format field_<incremental_id++>. Exemple :

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

devient:

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

Configuration requise:

• Doit être unique pour tous les alias d'agrégation.
• Respecter les limites de document field name.

Count

Agrégateur de nombres.

Sum

Agrégateur de somme.

Avg

Agrégateur moyen.

FieldReference

Champ à utiliser pour l'agrégation.

Int64Value

Facultatif. Contrainte facultative sur le nombre maximal de documents à compter.

Vous pouvez ainsi limiter le nombre de documents à analyser, et limiter la latence et les coûts.

"Non spécifié" est interprété comme étant sans limite.

Exemple général:

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

Configuration requise:

• La valeur doit être supérieure à zéro lorsqu'elle est présente.

FieldReference

Champ à utiliser pour l'agrégation.

Projection

Sous-ensemble facultatif de champs à renvoyer.

Il agit comme un DocumentMask sur les documents renvoyés par une requête. Si cette règle n'est pas définie, cela suppose que l'appelant souhaite que tous les champs soient renvoyés.

CollectionSelector

Collections à interroger.

Filter

Filtre à appliquer.

Order

Ordre à appliquer aux résultats de la requête.

Firestore permet aux appelants de proposer un tri complet, un ordre partiel ou un ordre nul. Dans tous les cas, Firestore garantit un ordre stable grâce aux règles suivantes:

• order_by est obligatoire pour référencer tous les champs utilisés avec un filtre d'inégalité.
• Tous les champs qui doivent figurer dans order_by, mais qui ne sont pas déjà présents sont ajoutés selon l'ordre lexicographique du nom du champ.
• Si une commande sur __name__ n'est pas spécifiée, elle est ajoutée par défaut.

Les champs sont ajoutés avec le même sens de tri que le dernier ordre spécifié ou "ASCENDING" si aucun ordre n'a été spécifié. Exemple :

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

Cursor

Préfixe potentiel d'une position dans l'ensemble de résultats à laquelle la requête doit commencer.

L'ordre de l'ensemble de résultats est basé sur la clause ORDER BY de la requête d'origine.

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

Les résultats de cette requête sont classés par (b ASC, __name__ ASC).

Les curseurs peuvent faire référence à l'ordre complet ou au préfixe du lieu, bien qu'ils ne puissent pas référencer plus de champs que le ORDER BY fourni.

Pour reprendre l'exemple ci-dessus, l'association des curseurs de début suivants aura un impact variable:

• START BEFORE (2, /k/123): commencer la requête juste avant a = 1 AND b > 2 AND __name__ > /k/123.
• START AFTER (10): lancer la requête juste après a = 1 AND b > 10.

Contrairement à OFFSET, qui nécessite d'analyser les N premiers résultats à ignorer, un curseur de début permet à la requête de commencer à une position logique. Cette position n'est pas obligatoire pour correspondre à un résultat réel. La recherche s'effectue à partir de cette position pour trouver le document suivant.

Configuration requise:

• Le nombre de valeurs ne peut pas être supérieur au nombre de champs spécifié dans la clause ORDER BY.

Cursor

Préfixe potentiel d'une position dans l'ensemble de résultats à laquelle terminer la requête.

Cette méthode est semblable à START_AT, mais elle contrôle la position de fin plutôt que la position de départ.

Configuration requise:

• Le nombre de valeurs ne peut pas être supérieur au nombre de champs spécifié dans la clause ORDER BY.

int32

Nombre de documents à ignorer avant de renvoyer le premier résultat.

Cela s'applique après les contraintes spécifiées par WHERE, START AT et END AT, mais avant la clause LIMIT.

Configuration requise:

• Si elle est spécifiée, la valeur doit être supérieure ou égale à zéro.

Int32Value

Nombre maximal de résultats à renvoyer.

S'applique après toutes les autres contraintes.

Configuration requise:

• Si elle est spécifiée, la valeur doit être supérieure ou égale à zéro.

FindNearest

Facultatif. Recherche des voisins les plus proches possible.

S'applique après tous les autres filtres et tris.

Recherche les représentations vectorielles continues les plus proches du vecteur de requête donné.

string

ID de collection. Lorsque cet ID est défini, cette option permet de ne sélectionner que les collections associées à cet ID.

bool

Si la valeur est "false", sélectionne uniquement les collections qui sont des enfants immédiats de l'élément parent spécifié dans le conteneur RunQueryRequest. Lorsque la valeur est "true", sélectionne toutes les collections descendantes.

Operator

Opérateur permettant de combiner plusieurs filtres.

Filter

Liste des filtres à combiner.

Configuration requise:

• Au moins un filtre est présent.

FieldReference

Champ selon lequel filtrer.

Operator

Opérateur utilisé pour le filtrage.

Value

Valeur à laquelle comparer.

string

Référence à un champ d'un document.

Configuration requise:

• DOIT être une chaîne de segments délimités par un point (.), où chaque segment est conforme aux limites document field name.

CompositeFilter

Filtre composite :

FieldFilter

Filtre appliqué à un champ de document.

UnaryFilter

Un filtre qui accepte exactement un argument.

FieldReference

Obligatoire. Champ de vecteur indexé à rechercher. Seuls les documents contenant des vecteurs dont la dimensionnalité correspond à query_vector peuvent être renvoyés.

Value

Obligatoire. Vecteur de requête que nous recherchons. La valeur doit être un vecteur de 2 048 dimensions au maximum.

DistanceMeasure

Obligatoire. Veuillez indiquer la mesure de distance à utiliser.

Int32Value

Obligatoire. Nombre de voisins les plus proches à renvoyer. La valeur doit être un entier positif inférieur ou égal à 1 000.

FieldReference

Champ selon lequel trier.

Direction

Sens de tri. La valeur par défaut est ASCENDING.

FieldReference

Champs à renvoyer.

Si ce champ est vide, tous les champs sont renvoyés. Pour ne renvoyer que le nom du document, utilisez ['__name__'].

Operator

Opérateur unaire à appliquer.

FieldReference

Champ auquel appliquer l'opérateur.

int32

ID de la cible dans le flux. La valeur doit être un nombre positif et non nul.

Si target_id est défini sur 0 (ou n'est pas spécifié), le serveur attribue un ID à cette cible et le renvoie dans un événement TargetChange::ADD. Une fois qu'une cible avec target_id=0 est ajoutée, toutes les cibles suivantes doivent également être associées à target_id=0. Si une requête AddTarget avec target_id != 0 est envoyée au serveur après l'ajout d'une cible avec target_id=0, le serveur envoie immédiatement une réponse avec un événement TargetChange::Remove.

Notez que si le client envoie plusieurs requêtes AddTarget sans ID, l'ordre des ID renvoyés dans TargetChage.target_ids n'est pas défini. Par conséquent, les clients doivent fournir un ID cible au lieu de compter sur le serveur pour en attribuer un.

Si la valeur de target_id est non nulle, aucune cible active existante ne doit exister sur ce flux avec le même ID.

bool

Si la cible doit être supprimée une fois qu'elle est à jour et cohérente.

Int32Value

Nombre de documents correspondant à la dernière requête au moment du jeton de CV ou de la lecture.

Cette valeur n'est pertinente que si resume_type est fourni. Cette valeur étant présente et supérieure à zéro, le client souhaite que ExistenceFilter.unchanged_names soit inclus dans la réponse.

QueryTarget

Cible spécifiée par une requête.

DocumentsTarget

Cible spécifiée par un ensemble de noms de documents.

bytes

Jeton de reprise d'une TargetChange précédente pour une cible identique.

L'utilisation d'un jeton de reprise avec une autre cible n'est pas acceptée et peut échouer.

Timestamp

Commencer l'écoute après un read_time spécifique.

Pour le moment, le client doit connaître l'état des documents correspondants.

string

Noms des documents à récupérer. Format à respecter: projects/{project_id}/databases/{database_id}/documents/{document_path}. La requête échoue si l'un des documents n'est pas une ressource enfant de l'élément database donné. Les noms en double sont supprimés.

string

Nom de la ressource parente. Format à respecter: projects/{project_id}/databases/{database_id}/documents ou projects/{project_id}/databases/{database_id}/documents/{document_path}. Par exemple: projects/my-project/databases/my-database/documents ou projects/my-project/databases/my-database/documents/chatrooms/my-chatroom.

StructuredQuery

Une requête structurée

TargetChangeType

Type de modification apportée.

int32

ID des cibles modifiées.

Si ce champ est vide, la modification s'applique à toutes les cibles.

L'ordre des ID cibles n'est pas défini.

Status

Erreur à l'origine de cette modification, le cas échéant.

bytes

Jeton pouvant être utilisé pour reprendre le flux pour le target_ids donné ou pour toutes les cibles si target_ids est vide.

Pas défini à chaque modification des cibles.

Timestamp

read_time cohérent pour le target_ids donné (omis lorsque les target_id ne correspondent pas à un instantané cohérent).

Le flux envoie forcément une read_time avec target_ids vide chaque fois que le flux entier atteint un nouvel instantané cohérent. Les messages ADD, CURRENT et RESET génèrent (à terme) un nouvel instantané cohérent (contrairement aux messages NO_CHANGE et REMOVE).

Pour un flux donné, l'augmentation de read_time est garantie de façon monotone.

ReadOnly

La transaction ne peut être utilisée que pour des opérations de lecture.

ReadWrite

La transaction peut être utilisée pour les opérations de lecture et d'écriture.

Timestamp

Lit les documents à l'heure indiquée.

Il doit s'agir d'un horodatage de précision de l'ordre de la microseconde au cours de la dernière heure. Si la récupération à un moment précis est activée, il peut également s'agir d'un horodatage d'une minute entière datant des sept derniers jours.

bytes

Transaction facultative à réessayer.

Document

Obligatoire. Document mis à jour. Crée le document s'il n'existe pas déjà.

DocumentMask

Champs à mettre à jour. Aucun des chemins d'accès des champs du masque ne peut contenir de nom réservé.

Si le document existe sur le serveur et qu'il comporte des champs non référencés dans le masque, ils ne sont pas modifiés. Les champs référencés dans le masque, mais non présents dans le document d'entrée, sont supprimés du document sur le serveur.

DocumentMask

Champs à renvoyer. Si ce champ n'est pas spécifié, tous les champs sont renvoyés.

Si le document comporte un champ qui n'est pas présent dans ce masque, il ne sera pas renvoyé dans la réponse.

Precondition

Une condition préalable facultative sur le document. La requête échoue si ce champ est défini et que le document cible n'y répond pas.

NullValue

Une valeur nulle.

bool

Une valeur booléenne.

int64

Valeur entière.

double

Une valeur double.

Timestamp

Une valeur d'horodatage.

Précision à la microseconde seulement. En cas de stockage, toute précision supplémentaire est arrondie au chiffre inférieur.

string

Valeur de chaîne.

La chaîne, représentée au format UTF-8, ne doit pas dépasser 1 Mio et 89 octets. Seuls les 1 500 premiers octets de la représentation UTF-8 sont pris en compte par les requêtes.

bytes

Valeur en octets.

Ne doit pas dépasser entre 1 Mio et 89 octets. Seuls les 1 500 premiers octets sont pris en compte par les requêtes.

string

Référence à un document. Exemple : projects/{project_id}/databases/{database_id}/documents/{document_path}.

LatLng

Valeur de point géographique représentant un point de la surface de la Terre.

ArrayValue

Valeur de tableau.

Ne peut pas contenir directement une autre valeur de tableau, mais peut contenir un mappage qui contient un autre tableau.

MapValue

Valeur de mappage

DocumentMask

Champs à mettre à jour dans cette écriture.

Ce champ ne peut être défini que lorsque l'opération est update. Si le masque n'est pas défini pour un update et que le document existe, toutes les données existantes seront écrasées. Si le masque est défini et que le document sur le serveur comporte des champs qui ne sont pas masqués, ceux-ci ne sont pas modifiés. Les champs référencés dans le masque, mais non présents dans le document d'entrée, sont supprimés du document sur le serveur. Les chemins d'accès aux champs de ce masque ne doivent pas contenir de nom de champ réservé.

FieldTransform

Transformations à effectuer après la mise à jour.

Ce champ ne peut être défini que lorsque l'opération est update. Si cette écriture est présente, cela équivaut à exécuter update et transform sur le même document de manière atomique et dans l'ordre.

Precondition

Une condition préalable facultative sur le document.

L'écriture échoue si elle est définie et si le document cible n'atteint pas cette condition.

Document

Un document à écrire.

string

Nom de document à supprimer. Format à respecter: projects/{project_id}/databases/{database_id}/documents/{document_path}.

DocumentTransform

Applique une transformation à un document.

string

Obligatoire. Nom de la base de données. Format à respecter: projects/{project_id}/databases/{database_id}. Cette étape n'est obligatoire que dans le premier message.

string

ID du flux d'écriture à reprendre. Vous ne pouvez définir cette option que dans le premier message. Si vous ne renseignez pas ce champ, un flux d'écriture est créé.

Write

Écritures à appliquer.

Toujours exécuté de manière atomique et dans l'ordre. Ce champ doit être vide dans la première requête. Peut être vide dans la dernière requête. Ce champ ne doit pas être vide pour toutes les autres requêtes.

bytes

Un jeton de flux précédemment envoyé par le serveur.

Le client doit définir ce champ sur le jeton du dernier WriteResponse qu'il a reçu. Cela confirme que le client a reçu des réponses jusqu'à ce jeton. Une fois ce jeton envoyé, les jetons plus anciens ne seront peut-être plus utilisés.

Le serveur peut fermer le flux si le nombre de réponses non confirmées est trop élevé.

Laissez ce champ non défini lorsque vous créez un flux. Pour reprendre un flux à un point spécifique, définissez ce champ ainsi que le champ stream_id.

Laissez ce champ non défini lorsque vous créez un flux.

map<string, string>

Étiquettes associés à cette requête d'écriture.

string

ID du flux. Défini uniquement pour le premier message, lorsqu'un flux a été créé.

bytes

Jeton qui représente la position de cette réponse dans le flux. Un client peut l'utiliser pour reprendre le flux à ce stade.

Ce champ est toujours défini.

WriteResult

Résultat de l'application des écritures.

Cette i-ième écriture correspond à l'i-ième écriture de la requête.

Timestamp

Heure à laquelle le commit a été effectué. Toute lecture avec un read_time égal ou supérieur voit les effets de l'écriture.

Timestamp

Heure de la dernière mise à jour du document après l'application de l'écriture. Non défini après delete.

Si l'écriture n'a pas réellement modifié le document, il s'agit de la valeur update_time précédente.

Value

Résultats de l'application de chaque DocumentTransform.FieldTransform, dans le même ordre.