Пакеты данных Cloud Firestore

Примечание. Пакеты данных — это дополнительная расширенная функция Cloud Firestore . Здесь мы рассматриваем пакеты данных, а также базовые понятия для понимания Cloud Firestore , чтобы вы знали о функциях, которые помогут вам управлять затратами на запросы после масштабирования вашего приложения. Прежде чем рассматривать пакеты данных, помимо прочтения других обзорных и концептуальных тем, обязательно прочтите руководство по выполнению запросов Cloud Firestore .

Пакеты данных Cloud Firestore — это статические файлы данных, созданные вами на основе снимков документов и запросов Cloud Firestore и опубликованные вами в CDN, службе хостинга или другом решении. Пакеты данных включают в себя как документы, которые вы хотите предоставить своим клиентским приложениям, так и метаданные о запросах, которые их сгенерировали. Вы используете клиентские SDK для загрузки пакетов по сети или из локального хранилища, после чего загружаете данные пакета в локальный кеш Cloud Firestore . После загрузки пакета клиентское приложение может запрашивать документы из локального кэша или серверной части.

Благодаря пакетам данных ваши приложения могут быстрее загружать результаты общих запросов, поскольку документы доступны при запуске без необходимости обращения к серверной части Cloud Firestore . Если результаты загружаются из локального кэша, вы также получаете выгоду от снижения затрат на доступ. Вместо того, чтобы платить за миллион экземпляров приложения для запроса одних и тех же первоначальных 100 документов, вы платите только за запросы, необходимые для объединения этих 100 документов.

Пакеты данных Cloud Firestore созданы для хорошей работы с другими серверными продуктами Firebase. Взгляните на интегрированное решение , в котором пакеты создаются Cloud Functions и предоставляются пользователям с помощью Firebase Hosting .

Использование пакета с вашим приложением включает в себя три шага:

1. Сборка пакета с помощью Admin SDK
2. Обслуживание пакета из локального хранилища или из CDN
3. Загрузка бандлов в клиенте

Что такое пакет данных?

Пакет данных — это статический двоичный файл, созданный вами для упаковки одного или нескольких снимков документов и/или запросов , из которого вы можете извлекать именованные запросы . Как мы обсудим ниже, серверные SDK позволяют создавать пакеты, а клиентские SDK предоставляют методы, позволяющие загружать пакеты в локальный кеш.

Именованные запросы — особенно мощная функция пакетов. Именованные запросы — это объекты Query , которые вы можете извлечь из пакета, а затем немедленно использовать для запроса данных либо из кэша, либо из серверной части, как вы обычно делаете в любой части вашего приложения, которая взаимодействует с Cloud Firestore .

Сборка пакетов данных на сервере

Использование Node.js или Java Admin SDK дает вам полный контроль над тем, что включать в пакеты и как их обслуживать.

Примечание. Обязательно объединяйте только общедоступные данные. Admin SDK действует как привилегированный пользователь и не оценивает правила безопасности; поэтому он объединяет любые документы или запрошенные данные независимо от ваших правил безопасности.

Node.js

var bundleId = "latest-stories";

var bundle = firestore.bundle(bundleId);

var docSnapshot = await firestore.doc('stories/stories').get();
var querySnapshot = await firestore.collection('stories').get();

// Build the bundle
// Note how querySnapshot is named "latest-stories-query"
var bundleBuffer = bundle.add(docSnapshot); // Add a document
                   .add('latest-stories-query', querySnapshot) // Add a named query.
                   .build()
      

Ява

Firestore db = FirestoreClient.getFirestore(app);

// Query the 50 latest stories
QuerySnapshot latestStories = db.collection("stories")
    .orderBy("timestamp", Direction.DESCENDING)
    .limit(50)
    .get()
    .get();

// Build the bundle from the query results
FirestoreBundle bundle = db.bundleBuilder("latest-stories")
    .add("latest-stories-query", latestStories)
    .build();
      

Питон

from google.cloud import firestore
from google.cloud.firestore_bundle import FirestoreBundle

db = firestore.Client()
bundle = FirestoreBundle("latest-stories")

doc_snapshot = db.collection("stories").document("news-item").get()
query = db.collection("stories")._query()

# Build the bundle
# Note how `query` is named "latest-stories-query"
bundle_buffer: str = bundle.add_document(doc_snapshot).add_named_query(
    "latest-stories-query", query,
).build()
      

Обслуживание пакетов данных

Вы можете предоставлять пакеты своим клиентским приложениям из CDN или загрузив их, например, из Cloud Storage .

Предположим, что пакет, созданный в предыдущем разделе, был сохранен в файле с именем bundle.txt и размещен на сервере. Этот файл пакета похож на любой другой ресурс, который вы можете обслуживать через Интернет, как показано здесь для простого приложения Node.js Express.

const fs = require('fs');
const server = require('http').createServer();

server.on('request', (req, res) => {
  const src = fs.createReadStream('./bundle.txt');
  src.pipe(res);
});

server.listen(8000);

Загрузка пакетов данных в клиенте

Вы загружаете пакеты Firestore, получая их с удаленного сервера, отправляя HTTP-запрос, вызывая API хранилища или используя любой другой метод получения двоичных файлов в сети.

После получения с помощью клиентского SDK Cloud Firestore ваше приложение вызывает метод loadBundle , который возвращает объект отслеживания задач, выполнение которых вы можете отслеживать так же, как отслеживаете состояние обещания. После успешного завершения задачи загрузки пакета содержимое пакета становится доступным в локальном кэше.

Web

Узнайте больше о модульном веб-API, поддерживающем древовидную структуру, и обновите API с пространством имен.

import { loadBundle, namedQuery, getDocsFromCache } from "firebase/firestore";

async function fetchFromBundle() {
  // Fetch the bundle from Firebase Hosting, if the CDN cache is hit the 'X-Cache'
  // response header will be set to 'HIT'
  const resp = await fetch('/createBundle');

  // Load the bundle contents into the Firestore SDK
  await loadBundle(db, resp.body);

  // Query the results from the cache
  const query = await namedQuery(db, 'latest-stories-query');
  const storiesSnap = await getDocsFromCache(query);

  // Use the results
  // ...
}
fs_bundle_load.js

Web

Узнайте больше о модульном веб-API, поддерживающем древовидную структуру, и обновите API с пространством имен.

// If you are using module bundlers.
import firebase from "firebase/app";
import "firebase/firestore";
import "firebase/firestore/bundle"; // This line enables bundle loading as a side effect.

// ...

async function fetchFromBundle() {
  // Fetch the bundle from Firebase Hosting, if the CDN cache is hit the 'X-Cache'
  // response header will be set to 'HIT'
  const resp = await fetch('/createBundle');

  // Load the bundle contents into the Firestore SDK
  await db.loadBundle(resp.body);

  // Query the results from the cache
  // Note: omitting "source: cache" will query the Firestore backend.
  const query = await db.namedQuery('latest-stories-query');
  const storiesSnap = await query.get({ source: 'cache' });

  // Use the results
  // ...
}
test.solution-bundles.js

Быстрый

Примечание. Этот продукт недоступен для целевых устройств watchOS и App Clip.

// Utility function for errors when loading bundles.
func bundleLoadError(reason: String) -> NSError {
  return NSError(domain: "FIRSampleErrorDomain",
                 code: 0,
                 userInfo: [NSLocalizedFailureReasonErrorKey: reason])
}

func fetchRemoteBundle(for firestore: Firestore,
                       from url: URL) async throws -> LoadBundleTaskProgress {
  guard let inputStream = InputStream(url: url) else {
    let error = self.bundleLoadError(reason: "Unable to create stream from the given url: \(url)")
    throw error
  }

  return try await firestore.loadBundle(inputStream)
}

// Fetches a specific named query from the provided bundle.
func loadQuery(named queryName: String,
               fromRemoteBundle bundleURL: URL,
               with store: Firestore) async throws -> Query {
  let _ = try await fetchRemoteBundle(for: store, from: bundleURL)
  if let query = await store.getQuery(named: queryName) {
    return query
  } else {
    throw bundleLoadError(reason: "Could not find query named \(queryName)")
  }
}

// Load a query and fetch its results from a bundle.
func runStoriesQuery() async {
  let queryName = "latest-stories-query"
  let firestore = Firestore.firestore()
  let remoteBundle = URL(string: "https://example.com/createBundle")!

  do {
    let query = try await loadQuery(named: queryName,
                                    fromRemoteBundle: remoteBundle,
                                    with: firestore)
    let snapshot = try await query.getDocuments()
    print(snapshot)
    // handle query results
  } catch {
    print(error)
  }
}
SolutionBundles.swift

Цель-C

Примечание. Этот продукт недоступен для целевых устройств watchOS и App Clip.

// Utility function for errors when loading bundles.
- (NSError *)bundleLoadErrorWithReason:(NSString *)reason {
  return [NSError errorWithDomain:@"FIRSampleErrorDomain"
                             code:0
                         userInfo:@{NSLocalizedFailureReasonErrorKey: reason}];
}

// Loads a remote bundle from the provided url.
- (void)fetchRemoteBundleForFirestore:(FIRFirestore *)firestore
                              fromURL:(NSURL *)url
                           completion:(void (^)(FIRLoadBundleTaskProgress *_Nullable,
                                                NSError *_Nullable))completion {
  NSInputStream *inputStream = [NSInputStream inputStreamWithURL:url];
  if (inputStream == nil) {
    // Unable to create input stream.
    NSError *error =
        [self bundleLoadErrorWithReason:
            [NSString stringWithFormat:@"Unable to create stream from the given url: %@", url]];
    completion(nil, error);
    return;
  }

  [firestore loadBundleStream:inputStream
                   completion:^(FIRLoadBundleTaskProgress * _Nullable progress,
                                NSError * _Nullable error) {
    if (progress == nil) {
      completion(nil, error);
      return;
    }

    if (progress.state == FIRLoadBundleTaskStateSuccess) {
      completion(progress, nil);
    } else {
      NSError *concreteError =
          [self bundleLoadErrorWithReason:
              [NSString stringWithFormat:
                  @"Expected bundle load to be completed, but got %ld instead",
                  (long)progress.state]];
      completion(nil, concreteError);
    }
    completion(nil, nil);
  }];
}

// Loads a bundled query.
- (void)loadQueryNamed:(NSString *)queryName
   fromRemoteBundleURL:(NSURL *)url
         withFirestore:(FIRFirestore *)firestore
            completion:(void (^)(FIRQuery *_Nullable, NSError *_Nullable))completion {
  [self fetchRemoteBundleForFirestore:firestore
                              fromURL:url
                           completion:^(FIRLoadBundleTaskProgress *progress, NSError *error) {
    if (error != nil) {
      completion(nil, error);
      return;
    }

    [firestore getQueryNamed:queryName completion:^(FIRQuery *query) {
      if (query == nil) {
        NSString *errorReason =
            [NSString stringWithFormat:@"Could not find query named %@", queryName];
        NSError *error = [self bundleLoadErrorWithReason:errorReason];
        completion(nil, error);
        return;
      }
      completion(query, nil);
    }];
  }];
}

- (void)runStoriesQuery {
  NSString *queryName = @"latest-stories-query";
  FIRFirestore *firestore = [FIRFirestore firestore];
  NSURL *bundleURL = [NSURL URLWithString:@"https://example.com/createBundle"];
  [self loadQueryNamed:queryName
   fromRemoteBundleURL:bundleURL
         withFirestore:firestore
            completion:^(FIRQuery *query, NSError *error) {
    // Handle query results
  }];
}
FIRSolutionsBundleViewController.m

Kotlin+KTX

@Throws(IOException::class)
fun getBundleStream(urlString: String?): InputStream {
    val url = URL(urlString)
    val connection = url.openConnection() as HttpURLConnection
    return connection.inputStream
}

@Throws(IOException::class)
fun fetchFromBundle() {
    val bundleStream = getBundleStream("https://example.com/createBundle")
    val loadTask = db.loadBundle(bundleStream)

    // Chain the following tasks
    // 1) Load the bundle
    // 2) Get the named query from the local cache
    // 3) Execute a get() on the named query
    loadTask.continueWithTask<Query> { task ->
        // Close the stream
        bundleStream.close()

        // Calling .result propagates errors
        val progress = task.getResult(Exception::class.java)

        // Get the named query from the bundle cache
        db.getNamedQuery("latest-stories-query")
    }.continueWithTask { task ->
        val query = task.getResult(Exception::class.java)!!

        // get() the query results from the cache
        query.get(Source.CACHE)
    }.addOnCompleteListener { task ->
        if (!task.isSuccessful) {
            Log.w(TAG, "Bundle loading failed", task.exception)
            return@addOnCompleteListener
        }

        // Get the QuerySnapshot from the bundle
        val storiesSnap = task.result

        // Use the results
        // ...
    }
}
SolutionBundles.kt

Java

public InputStream getBundleStream(String urlString) throws IOException {
    URL url = new URL(urlString);
    HttpURLConnection connection = (HttpURLConnection) url.openConnection();
    return connection.getInputStream();
}

public void fetchBundleFrom() throws IOException {
    final InputStream bundleStream = getBundleStream("https://example.com/createBundle");
    LoadBundleTask loadTask = db.loadBundle(bundleStream);

    // Chain the following tasks
    // 1) Load the bundle
    // 2) Get the named query from the local cache
    // 3) Execute a get() on the named query
    loadTask.continueWithTask(new Continuation<LoadBundleTaskProgress, Task<Query>>() {
        @Override
        public Task<Query> then(@NonNull Task<LoadBundleTaskProgress> task) throws Exception {
            // Close the stream
            bundleStream.close();

            // Calling getResult() propagates errors
            LoadBundleTaskProgress progress = task.getResult(Exception.class);

            // Get the named query from the bundle cache
            return db.getNamedQuery("latest-stories-query");
        }
    }).continueWithTask(new Continuation<Query, Task<QuerySnapshot>>() {
        @Override
        public Task<QuerySnapshot> then(@NonNull Task<Query> task) throws Exception {
            Query query = task.getResult(Exception.class);

            // get() the query results from the cache
            return query.get(Source.CACHE);
        }
    }).addOnCompleteListener(new OnCompleteListener<QuerySnapshot>() {
        @Override
        public void onComplete(@NonNull Task<QuerySnapshot> task) {
            if (!task.isSuccessful()) {
                Log.w(TAG, "Bundle loading failed", task.getException());
                return;
            }

            // Get the QuerySnapshot from the bundle
            QuerySnapshot storiesSnap = task.getResult();

            // Use the results
            // ...
        }
    });
}
SolutionBundles.java

С++

db->LoadBundle("bundle_name", [](const LoadBundleTaskProgress& progress) {
  switch(progress.state()) {
    case LoadBundleTaskProgress::State::kError: {
      // The bundle load has errored. Handle the error in the returned future.
      return;
    }
    case LoadBundleTaskProgress::State::kInProgress: {
      std::cout << "Bytes loaded from bundle: " << progress.bytes_loaded()
                << std::endl;
      break;
    }
    case LoadBundleTaskProgress::State::kSuccess: {
      std::cout << "Bundle load succeeeded" << std::endl;
      break;
    }
  }
}).OnCompletion([db](const Future<LoadBundleTaskProgress>& future) {
  if (future.error() != Error::kErrorOk) {
    // Handle error...
    return;
  }

  const std::string& query_name = "latest_stories_query";
  db->NamedQuery(query_name).OnCompletion([](const Future<Query>& query_future){
    if (query_future.error() != Error::kErrorOk) {
      // Handle error...
      return;
    }

    const Query* query = query_future.result();
    query->Get().OnCompletion([](const Future<QuerySnapshot> &){
      // ...
    });
  });
});
snippets.cpp

Обратите внимание: если вы загружаете именованный запрос из пакета, созданного менее 30 минут назад, и используете его для чтения из серверной части, а не из кеша, вы платите только за чтение базы данных, необходимое для обновления документов в соответствии с тем, что хранится на серверной части. ; то есть вы платите только за дельты.

Что дальше?

• Обратитесь к справочной документации по API пакетов данных для клиентской стороны ( Apple , Android , веб ) и серверной части ( Node.js ).

• Если вы еще этого не сделали, ознакомьтесь с решением Cloud Functions и Firebase Hosting для создания и обслуживания пакетов .