Przykład

Opis

Zwraca niedeterministyczną próbkę z wyników poprzedniego etapu.

Obsługiwane są 2 tryby:

  • documents – losowo wybiera n dokumentów.
  • percent – losowo wybiera n procent dokumentów.

Przykłady

Web

let results;

// Get a sample of 100 documents in a database
results = await execute(db.pipeline()
  .database()
  .sample(100)
);

// Randomly shuffle a list of 3 documents
results = await execute(db.pipeline()
  .documents([
    doc(db, "cities", "SF"),
    doc(db, "cities", "NY"),
    doc(db, "cities", "DC"),
  ])
  .sample(3)
);
Swift
var results: Pipeline.Snapshot

// Get a sample of 100 documents in a database
results = try await db.pipeline()
  .database()
  .sample(count: 100)
  .execute()

// Randomly shuffle a list of 3 documents
results = try await db.pipeline()
  .documents([
    db.collection("cities").document("SF"),
    db.collection("cities").document("NY"),
    db.collection("cities").document("DC"),
  ])
  .sample(count: 3)
  .execute()

Kotlin

var results: Task<Pipeline.Snapshot>

// Get a sample of 100 documents in a database
results = db.pipeline()
    .database()
    .sample(100)
    .execute()

// Randomly shuffle a list of 3 documents
results = db.pipeline()
    .documents(
        db.collection("cities").document("SF"),
        db.collection("cities").document("NY"),
        db.collection("cities").document("DC")
    )
    .sample(3)
    .execute()

Java

Task<Pipeline.Snapshot> results;

// Get a sample of 100 documents in a database
results = db.pipeline()
    .database()
    .sample(100)
    .execute();

// Randomly shuffle a list of 3 documents
results = db.pipeline()
    .documents(
        db.collection("cities").document("SF"),
        db.collection("cities").document("NY"),
        db.collection("cities").document("DC")
    )
    .sample(3)
    .execute();
Python
# Get a sample of 100 documents in a database
results = client.pipeline().database().sample(100).execute()

# Randomly shuffle a list of 3 documents
results = (
    client.pipeline()
    .documents(
        client.collection("cities").document("SF"),
        client.collection("cities").document("NY"),
        client.collection("cities").document("DC"),
    )
    .sample(3)
    .execute()
)
Java
// Get a sample of 100 documents in a database
Pipeline.Snapshot results1 = firestore.pipeline().database().sample(100).execute().get();

// Randomly shuffle a list of 3 documents
Pipeline.Snapshot results2 =
    firestore
        .pipeline()
        .documents(
            firestore.collection("cities").document("SF"),
            firestore.collection("cities").document("NY"),
            firestore.collection("cities").document("DC"))
        .sample(3)
        .execute()
        .get();
Go
// Get a sample of 100 documents in a database
results1, err := client.Pipeline().Database().Sample(firestore.WithDocLimit(100)).Execute(ctx).Results().GetAll()
if err != nil {
	fmt.Fprintf(w, "GetAll failed: %v", err)
	return err
}

// Randomly shuffle a list of 3 documents
results2, err := client.Pipeline().
	Documents([]*firestore.DocumentRef{
		client.Collection("cities").Doc("SF"),
		client.Collection("cities").Doc("NY"),
		client.Collection("cities").Doc("DC"),
	}).
	Sample(firestore.WithDocLimit(3)).
	Execute(ctx).Results().GetAll()
if err != nil {
	fmt.Fprintf(w, "GetAll failed: %v", err)
	return err
}

Tryby

Tryb Dokumenty

W trybie documents losowo wybieranych jest maksymalnie n dokumentów z danych wejściowych. Każdy dokument (wraz z kolejnością dokumentów) ma takie samo prawdopodobieństwo wybrania. Aby to osiągnąć, Cloud Firestore musi nadal skanować i przetwarzać wszystkie dokumenty, co może być kosztowną operacją.

Na przykład w przypadku tej kolekcji:

Node.js

await db.collection("cities").doc("SF").set({name: "San Francsico", state: "California"});
await db.collection("cities").doc("NYC").set({name: "New York City", state: "New York"});
await db.collection("cities").doc("CHI").set({name: "Chicago", state: "Illinois"});

Etap próbkowania w trybie dokumentu może służyć do pobierania niedeterministycznego podzbioru wyników z tej kolekcji.

Node.js

const sampled = await db.pipeline()
    .collection("/cities")
    .sample(1)
    .execute();

W tym przykładzie losowo zwracany jest tylko 1 dokument.

  { name: "New York City", state: "New York" }

Jeśli podana liczba jest większa niż łączna liczba zwróconych dokumentów, wszystkie dokumenty są zwracane w losowej kolejności.

Node.js

const sampled = await db.pipeline()
    .collection("/cities")
    .sample(5)
    .execute();

Spowoduje to zwrócenie tych dokumentów:

  { name: "New York City", state: "New York" }
  { name: "Chicago", state: "Illinois" }
  { name: "San Francisco", state: "California" }

Tryb procentowy

W trybie percent próbuje się wybrać n procent wszystkich dokumentów z danych wejściowych. W rezultacie etap generuje około # documents * percent / 100 dokumentów. Podobnie jak w trybie documents, Cloud Firestore zapewnia, że każdy dokument ma takie samo prawdopodobieństwo zwrócenia. Wymaga to jednak, aby Cloud Firestore skanował i przetwarzał wszystkie dokumenty, co może być kosztowną operacją, nawet jeśli zbiór wyników jest mały.

W przeciwieństwie do trybu documents kolejność nie jest losowa, ale zachowuje dotychczasową kolejność dokumentów. Wartość procentowa musi być liczbą zmiennoprzecinkową z zakresu od 0.0 do 1.0.

Na przykład w przypadku tej kolekcji:

Node.js

await db.collection("cities").doc("SF").set({name: "San Francsico", state: "California"});
await db.collection("cities").doc("NYC").set({name: "New York City", state: "New York"});
await db.collection("cities").doc("CHI").set({name: "Chicago", state: "Illinois"});
await db.collection("cities").doc("ATL").set({name: "Atlanta", state: "Georgia"});

Etap próbkowania w trybie procentowym może służyć do pobierania (średnio) 50% dokumentów z etapu collection(...).

Node.js

  const sampled = await db.pipeline()
    .collection("/cities")
    .sample({ percent: 0.5 })
    .execute();

Spowoduje to zwrócenie niedeterministycznej próbki (średnio) 50% dokumentów z kolekcji cities. Oto jedno z możliwych wyjść.

  { name: "New York City", state: "New York" }
  { name: "Chicago", state: "Illinois" }

W trybie procentowym każdy dokument ma takie samo prawdopodobieństwo wybrania, dlatego możliwe jest, że nie zostaną zwrócone żadne dokumenty lub zostaną zwrócone wszystkie dokumenty.

Przykłady klientów

Web

// Get a sample of on average 50% of the documents in the database
const results = await execute(db.pipeline()
  .database()
  .sample({ percentage: 0.5 })
);
Swift
// Get a sample of on average 50% of the documents in the database
let results = try await db.pipeline()
  .database()
  .sample(percentage: 0.5)
  .execute()

Kotlin

// Get a sample of on average 50% of the documents in the database
val results = db.pipeline()
    .database()
    .sample(SampleStage.withPercentage(0.5))
    .execute()

Java

// Get a sample of on average 50% of the documents in the database
Task<Pipeline.Snapshot> results = db.pipeline()
    .database()
    .sample(SampleStage.withPercentage(0.5))
    .execute();
Python
from google.cloud.firestore_v1.pipeline_stages import SampleOptions

# Get a sample of on average 50% of the documents in the database
results = (
    client.pipeline().database().sample(SampleOptions.percentage(0.5)).execute()
)
Java
// Get a sample of on average 50% of the documents in the database
Pipeline.Snapshot results =
    firestore.pipeline().database().sample(Sample.withPercentage(0.5)).execute().get();
Go
// Get a sample of on average 50% of the documents in the database
snapshot := client.Pipeline().
	Database().
	Sample(firestore.WithPercentage(0.5)).
	Execute(ctx)