Documentation de référence sur les fonctions de comparaison

Aperçu — Firestore en mode natif (avec opérations de pipeline) pour l'édition Enterprise

Cette fonctionnalité est soumise aux "Conditions des offres de pré-DG" de la section "Conditions générales du service" des Conditions spécifiques du service. Vous pouvez traiter des données à caractère personnel pour cette fonctionnalité, comme indiqué dans l'Avenant relatif au traitement des données dans le cloud, sous réserve de respecter les obligations et restrictions décrites dans le contrat en vertu duquel vous accédez à Google Cloud. Les fonctionnalités pré-DG sont disponibles "en l'état" et peuvent avoir une prise en charge limitée. Pour en savoir plus, consultez les descriptions des étapes de lancement.

Fonctions de comparaison

Nom	Description
`EQUAL`	Comparaison d'égalité
`GREATER_THAN`	Comparaison "Supérieur à"
`GREATER_THAN_OR_EQUAL`	Comparaison "supérieur ou égal à"
`LESS_THAN`	Comparaison "Inférieur à"
`LESS_THAN_OR_EQUAL`	Comparaison "inférieur ou égal à"
`NOT_EQUAL`	Comparaison "Est différent de"
`CMP`	Comparaison générale

EQUAL

Syntaxe :

equal(x: ANY, y: ANY) -> BOOLEAN

Exemples :

`x`	`y`	`equal(x, y)`
1L	1L	`TRUE`
1.0	1L	`TRUE`
-1.0	1L	`FALSE`
NaN	NaN	`TRUE`
`NULL`	`NULL`	`TRUE`
`NULL`	`ABSENT`	`FALSE`

Description :

Renvoie TRUE si x et y sont égaux, ou FALSE si ce n'est pas le cas.

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(field("rating").equal(5).as("hasPerfectRating"))
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(field("rating").equal(5).as("hasPerfectRating"))
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([Field("rating").equal(5).as("hasPerfectRating")])
  .execute()PipelineSnippets.swift

Kotlin
Android

val result = db.pipeline()
    .collection("books")
    .select(field("rating").equal(5).alias("hasPerfectRating"))
    .execute()DocSnippets.kt

Java
Android

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(field("rating").equal(5).alias("hasPerfectRating"))
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("rating").equal(5).as_("hasPerfectRating"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(equal(field("rating"), 5).as("hasPerfectRating"))
        .execute()
        .get();PipelineSnippets.java

GREATER_THAN

Syntaxe :

greater_than(x: ANY, y: ANY) -> BOOLEAN

Description :

Renvoie TRUE si la valeur de x est supérieure à y, et FALSE dans le cas contraire.

Si x et y ne sont pas comparables, renvoie FALSE.

Exemples :

`x`	`y`	`greater_than(x, y)`
1L	0,0	`TRUE`
1L	1L	`FALSE`
1L	2L	`FALSE`
"foo"	0L	`FALSE`
0L	"foo"	`FALSE`
NaN	0L	`FALSE`
0L	NaN	`FALSE`
`NULL`	`NULL`	`FALSE`

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(field("rating").greaterThan(4).as("hasHighRating"))
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(field("rating").greaterThan(4).as("hasHighRating"))
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([Field("rating").greaterThan(4).as("hasHighRating")])
  .execute()PipelineSnippets.swift

Kotlin
Android

val result = db.pipeline()
    .collection("books")
    .select(field("rating").greaterThan(4).alias("hasHighRating"))
    .execute()DocSnippets.kt

Java
Android

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(field("rating").greaterThan(4).alias("hasHighRating"))
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("rating").greater_than(4).as_("hasHighRating"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(greaterThan(field("rating"), 4).as("hasHighRating"))
        .execute()
        .get();PipelineSnippets.java

GREATER_THAN_OR_EQUAL

Syntaxe :

greater_than_or_equal(x: ANY, y: ANY) -> BOOLEAN

Description :

Renvoie TRUE si x est supérieur ou égal à y, et FALSE dans le cas contraire.

Si x et y ne sont pas comparables, renvoie FALSE.

Exemples :

`x`	`y`	`greater_than_or_equal(x, y)`
1L	0,0	`TRUE`
1L	1L	`TRUE`
1L	2L	`FALSE`
"foo"	0L	`FALSE`
0L	"foo"	`FALSE`
NaN	0L	`FALSE`
0L	NaN	`FALSE`
`NULL`	`NULL`	`TRUE`

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(field("published").greaterThanOrEqual(1900).as("publishedIn20thCentury"))
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(field("published").greaterThanOrEqual(1900).as("publishedIn20thCentury"))
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([Field("published").greaterThanOrEqual(1900).as("publishedIn20thCentury")])
  .execute()PipelineSnippets.swift

Kotlin
Android

val result = db.pipeline()
    .collection("books")
    .select(field("published").greaterThanOrEqual(1900).alias("publishedIn20thCentury"))
    .execute()DocSnippets.kt

Java
Android

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(field("published").greaterThanOrEqual(1900).alias("publishedIn20thCentury"))
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(
        Field.of("published")
        .greater_than_or_equal(1900)
        .as_("publishedIn20thCentury")
    )
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(greaterThanOrEqual(field("published"), 1900).as("publishedIn20thCentury"))
        .execute()
        .get();PipelineSnippets.java

LESS_THAN

Syntaxe :

less_than(x: ANY, y: ANY) -> BOOLEAN

Description :

Renvoie TRUE si la valeur de x est inférieure à y, ou FALSE si ce n'est pas le cas.

Si x et y ne sont pas comparables, renvoie FALSE.

Exemples :

`x`	`y`	`less_than(x, y)`
1L	0,0	`FALSE`
1L	1L	`FALSE`
1L	2L	`TRUE`
"foo"	0L	`FALSE`
0L	"foo"	`FALSE`
NaN	0L	`FALSE`
0L	NaN	`FALSE`
`NULL`	`NULL`	`FALSE`

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(field("published").lessThan(1923).as("isPublicDomainProbably"))
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(field("published").lessThan(1923).as("isPublicDomainProbably"))
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([Field("published").lessThan(1923).as("isPublicDomainProbably")])
  .execute()PipelineSnippets.swift

Kotlin
Android

val result = db.pipeline()
    .collection("books")
    .select(field("published").lessThan(1923).alias("isPublicDomainProbably"))
    .execute()DocSnippets.kt

Java
Android

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(field("published").lessThan(1923).alias("isPublicDomainProbably"))
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("published").less_than(1923).as_("isPublicDomainProbably"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(lessThan(field("published"), 1923).as("isPublicDomainProbably"))
        .execute()
        .get();PipelineSnippets.java

LESS_THAN_OR_EQUAL

Syntaxe :

less_than_or_equal(x: ANY, y: ANY) -> BOOLEAN

Description :

Renvoie TRUE si x est inférieur ou égal à y, et FALSE dans le cas contraire.

Si x et y ne sont pas comparables, renvoie FALSE.

Exemples :

`x`	`y`	`less_than(x, y)`
1L	0,0	`FALSE`
1L	1L	`TRUE`
1L	2L	`TRUE`
"foo"	0L	`FALSE`
0L	"foo"	`FALSE`
NaN	0L	`FALSE`
0L	NaN	`FALSE`
`NULL`	`NULL`	`TRUE`

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(field("rating").lessThanOrEqual(2).as("hasBadRating"))
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(field("rating").lessThanOrEqual(2).as("hasBadRating"))
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([Field("rating").lessThanOrEqual(2).as("hasBadRating")])
  .execute()PipelineSnippets.swift

Kotlin
Android

val result = db.pipeline()
    .collection("books")
    .select(field("rating").lessThanOrEqual(2).alias("hasBadRating"))
    .execute()DocSnippets.kt

Java
Android

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(field("rating").lessThanOrEqual(2).alias("hasBadRating"))
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("rating").less_than_or_equal(2).as_("hasBadRating"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(lessThanOrEqual(field("rating"), 2).as("hasBadRating"))
        .execute()
        .get();PipelineSnippets.java

NOT_EQUAL

Syntaxe :

not_equal(x: ANY, y: ANY) -> BOOLEAN

Description :

Renvoie TRUE si la valeur de x n'est pas égale à y, ou FALSE si ce n'est pas le cas.

Exemples :

`x`	`y`	`not_equal(x, y)`
1L	1L	`FALSE`
1.0	1L	`FALSE`
-1.0	1L	`TRUE`
NaN	0L	`TRUE`
NaN	NaN	`FALSE`
`NULL`	`NULL`	`FALSE`
`NULL`	`ABSENT`	`TRUE`

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(field("title").notEqual("1984").as("not1984"))
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(field("title").notEqual("1984").as("not1984"))
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([Field("title").notEqual("1984").as("not1984")])
  .execute()PipelineSnippets.swift

Kotlin
Android

val result = db.pipeline()
    .collection("books")
    .select(field("title").notEqual("1984").alias("not1984"))
    .execute()DocSnippets.kt

Java
Android

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(field("title").notEqual("1984").alias("not1984"))
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("title").not_equal("1984").as_("not1984"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(notEqual(field("title"), "1984").as("not1984"))
        .execute()
        .get();PipelineSnippets.java

CMP

Syntaxe :

cmp(x: ANY, y: ANY) -> Int64

Description :

Compare x et y, et renvoie :

1L si x est supérieur à y.
-1L si x est inférieur à y.
Sinon, 0L.

Contrairement aux autres fonctions de comparaison, la fonction cmp(...) fonctionne sur tous les types, en suivant le même ordre que celui utilisé dans l'étape sort(...). Consultez la section Ordre des types de valeurs pour savoir comment les valeurs sont ordonnées selon les types.

Exemples :

`x`	`y`	`cmp(x, y)`
1L	1L	0L
1.0	1L	0L
-1.0	1L	-1L
42.5D	"foo"	-1L
`NULL`	`NULL`	0L
`NULL`	`ABSENT`	0L

Étapes suivantes

Consultez la présentation des requêtes de pipeline.

Documentation de référence sur les fonctions de comparaison

Fonctions de comparaison

EQUAL

Node.js

Web

Swift

KotlinAndroid

JavaAndroid

Python

Java

GREATER_THAN

Node.js

Web

Swift

KotlinAndroid

JavaAndroid

Python

Java

GREATER_THAN_OR_EQUAL

Node.js

Web

Swift

KotlinAndroid

JavaAndroid

Python

Java

LESS_THAN

Node.js

Web

Swift

KotlinAndroid

JavaAndroid

Python

Java

LESS_THAN_OR_EQUAL

Node.js

Web

Swift

KotlinAndroid

JavaAndroid

Python

Java

NOT_EQUAL

Node.js

Web

Swift

KotlinAndroid

JavaAndroid

Python

Java

CMP

Étapes suivantes

Kotlin
Android

Java
Android

Kotlin
Android

Java
Android

Kotlin
Android

Java
Android

Kotlin
Android

Java
Android

Kotlin
Android

Java
Android

Kotlin
Android

Java
Android