firebase-admin.firestore package

Реэкспорт внешнего API

Следующие внешне определенные API для удобства реэкспортируются из этой точки входа модуля.

Символ	Описание
Массовый писатель	Тип BulkWriter из пакета @google-cloud/firestore .
Агрегатефилд	Тип AggregateField из пакета @google-cloud/firestore .
BulkWriterOptions	Тип BulkWriterOptions из пакета @google-cloud/firestore .
BundleBuilder	Тип BundleBuilder из пакета @google-cloud/firestore .
Группа Коллекции	Тип CollectionGroup из пакета @google-cloud/firestore .
КоллекцияСправочник	Тип CollectionReference из пакета @google-cloud/firestore .
Изменение документа	Тип DocumentChange из пакета @google-cloud/firestore .
ДокументДанные	Тип DocumentData из пакета @google-cloud/firestore .
Ссылка на документ	Тип DocumentReference из пакета @google-cloud/firestore .
Снимок документа	Тип DocumentSnapshot из пакета @google-cloud/firestore .
ФилдПат	Тип FieldPath из пакета @google-cloud/firestore .
ПолеValue	Тип FieldValue из пакета @google-cloud/firestore .
Фильтр	Тип Filter из пакета @google-cloud/firestore .
Пожарная лавка	Тип Firestore из пакета @google-cloud/firestore .
FirestoreDataConverter	Тип FirestoreDataConverter из пакета @google-cloud/firestore .
ГеоПойнт	Тип GeoPoint из пакета @google-cloud/firestore .
Грпкстатус	Тип GrpcStatus из пакета @google-cloud/firestore .
Предварительное условие	Тип Precondition из пакета @google-cloud/firestore .
Запрос	Тип Query из пакета @google-cloud/firestore .
Снимок документа запроса	Тип QueryDocumentSnapshot из пакета @google-cloud/firestore .
QueryPartition	Тип QueryPartition из пакета @google-cloud/firestore .
Снимок запроса	Тип QuerySnapshot из пакета @google-cloud/firestore .
ReadOptions	Введите ReadOptions из пакета @google-cloud/firestore .
Установить параметры	Введите SetOptions из пакета @google-cloud/firestore .
Временная метка	Тип Timestamp из пакета @google-cloud/firestore .
Сделка	Тип Transaction из пакета @google-cloud/firestore .
Запись пакета	Тип WriteBatch из пакета @google-cloud/firestore .
WriteResult	Тип WriteResult из пакета @google-cloud/firestore .
setLogFunction	setLogFunction из пакета @google-cloud/firestore .

Облачный пожарный магазин.

Функции

Функция	Описание
getFirestore()	Получает службу Firestore по умолчанию для приложения по умолчанию.
getFirestore (приложение)	Получает службу Firestore по умолчанию для данного приложения.
getFirestore (идентификатор базы данных)	(БЕТА) Получает именованный сервис Firestore для приложения по умолчанию.
getFirestore (приложение, идентификатор базы данных)	(БЕТА) Получает именованный сервис Firestore для данного приложения.
инициализироватьFirestore (приложение, настройки)	Получает службу Firestore по умолчанию для данного приложения, передавая дополнительные параметры его конструктору.
инициализироватьFirestore (приложение, настройки, идентификатор базы данных)	(БЕТА) Получает именованный сервис Firestore для данного приложения, передавая дополнительные параметры его конструктору.

Классы

Сорт	Описание
FirebaseFirestoreError	Структура кода ошибки Firebase Firestore. Это расширяет FirebaseError.

Интерфейсы

Интерфейс	Описание
Настройки Firestore	Настройки для передачи конструктору Firestore.

getFirestore()

Получает службу Firestore по умолчанию для приложения по умолчанию.

Подпись:

export declare function getFirestore(): Firestore;

Возврат:

Пожарная лавка

Служба Firestore по умолчанию для приложения по умолчанию.

Пример

// Get the default Firestore service for the default app
const defaultFirestore = getFirestore();

getFirestore (приложение)

Получает службу Firestore по умолчанию для данного приложения.

Подпись:

export declare function getFirestore(app: App): Firestore;

Параметры

Параметр	Тип	Описание
приложение	Приложение	какой сервис Firestore вернуть.

Возврат:

Пожарная лавка

Служба Firestore по умолчанию, связанная с предоставленным приложением.

Пример

// Get the default Firestore service for a specific app
const otherFirestore = getFirestore(app);

getFirestore (идентификатор базы данных)

Этот API предоставляется в качестве предварительной версии для разработчиков и может меняться в зависимости от получаемых нами отзывов. Не используйте этот API в производственной среде.

Получает именованный сервис Firestore для приложения по умолчанию.

Подпись:

export declare function getFirestore(databaseId: string): Firestore;

Параметры

Параметр	Тип	Описание
идентификатор базы данных	нить	имя базы данных для возврата.

Возврат:

Пожарная лавка

Именованный сервис Firestore для приложения по умолчанию.

Пример

// Get the Firestore service for a named database and default app
const otherFirestore = getFirestore('otherDb');

getFirestore (приложение, идентификатор базы данных)

Этот API предоставляется в качестве предварительной версии для разработчиков и может меняться в зависимости от получаемых нами отзывов. Не используйте этот API в производственной среде.

Получает именованный сервис Firestore для данного приложения.

Подпись:

export declare function getFirestore(app: App, databaseId: string): Firestore;

Параметры

Параметр	Тип	Описание
приложение	Приложение	какой сервис Firestore вернуть.
идентификатор базы данных	нить	имя базы данных для возврата.

Возврат:

Пожарная лавка

Именованный сервис Firestore , связанный с предоставленным приложением.

Пример

// Get the Firestore service for a named database and specific app.
const otherFirestore = getFirestore('otherDb');

инициализироватьFirestore (приложение, настройки)

Получает службу Firestore по умолчанию для данного приложения, передавая дополнительные параметры его конструктору.

Подпись:

export declare function initializeFirestore(app: App, settings?: FirestoreSettings): Firestore;

Параметры

Параметр	Тип	Описание
приложение	Приложение	какой сервис Firestore вернуть.
настройки	Настройки Firestore	Объект настроек, который будет передан конструктору.

Возврат:

Пожарная лавка

Служба Firestore по умолчанию, связанная с предоставленным приложением и настройками.

Пример

// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true});

инициализироватьFirestore (приложение, настройки, идентификатор базы данных)

Этот API предоставляется в качестве предварительной версии для разработчиков и может меняться в зависимости от получаемых нами отзывов. Не используйте этот API в производственной среде.

Получает именованный сервис Firestore для данного приложения, передавая дополнительные параметры его конструктору.

Подпись:

export declare function initializeFirestore(app: App, settings: FirestoreSettings, databaseId: string): Firestore;

Параметры

Параметр	Тип	Описание
приложение	Приложение	какой сервис Firestore вернуть.
настройки	Настройки Firestore	Объект настроек, который будет передан конструктору.
идентификатор базы данных	нить	имя базы данных для возврата.

Возврат:

Пожарная лавка

Именованная служба Firestore , связанная с предоставленным приложением и настройками.

Пример

// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true}, 'otherDb');