firebase-admin.firestore package

ייצוא מחדש של API חיצוני

ממשקי ה-API המוגדרים חיצונית הבאים מיוצאים מחדש מנקודת הכניסה של המודול הזה מטעמי נוחות.

סֵמֶל תיאור
BulkWriter סוג BulkWriter מחבילת @google-cloud/firestore .
שדה מצטבר סוג AggregateField מחבילת @google-cloud/firestore .
BulkWriterOptions סוג BulkWriterOptions מחבילת @google-cloud/firestore .
BundleBuilder סוג BundleBuilder מחבילת @google-cloud/firestore .
CollectionGroup סוג CollectionGroup מחבילת @google-cloud/firestore .
הפניה לאוסף סוג CollectionReference מחבילת @google-cloud/firestore .
שינוי מסמך סוג DocumentChange מחבילת @google-cloud/firestore .
DocumentData סוג DocumentData מחבילת @google-cloud/firestore .
הפניה למסמך סוג DocumentReference מחבילת @google-cloud/firestore .
DocumentSnapshot סוג DocumentSnapshot מחבילת @google-cloud/firestore .
FieldPath סוג FieldPath מחבילת @google-cloud/firestore .
FieldValue סוג FieldValue מחבילת @google-cloud/firestore .
לְסַנֵן סוג Filter מחבילת @google-cloud/firestore .
Firestore סוג Firestore מחבילת @google-cloud/firestore .
FirestoreDataConverter סוג FirestoreDataConverter מחבילת @google-cloud/firestore .
GeoPoint סוג GeoPoint מחבילת @google-cloud/firestore .
GrpcStatus סוג GrpcStatus מחבילת @google-cloud/firestore .
תְנַאִי מוּקדָם סוג Precondition מחבילת @google-cloud/firestore .
שאילתא סוג Query מחבילת @google-cloud/firestore .
QueryDocumentSnapshot סוג QueryDocumentSnapshot מחבילת @google-cloud/firestore .
QueryPartition סוג QueryPartition מחבילת @google-cloud/firestore .
QuerySnapshot סוג QuerySnapshot מחבילת @google-cloud/firestore .
אפשרויות קריאה סוג ReadOptions מחבילת @google-cloud/firestore .
הגדר אפשרויות סוג SetOptions מחבילת @google-cloud/firestore .
חותמת זמן סוג Timestamp @google-cloud/firestore .
עִסקָה סוג Transaction מחבילת @google-cloud/firestore .
WriteBatch סוג WriteBatch מחבילת @google-cloud/firestore .
כתוב תוצאה סוג WriteResult מחבילת @google-cloud/firestore .
setLogFunction פונקציית setLogFunction מחבילת @google-cloud/firestore .

Cloud Firestore.

פונקציות

פוּנקצִיָה תיאור
getFirestore() מקבל את שירות ברירת המחדל של Firestore עבור אפליקציית ברירת המחדל.
getFirestore(אפליקציה) מקבל את שירות ברירת המחדל של Firestore עבור האפליקציה הנתונה.
getFirestore(databaseId) (ביטא) מקבל את שירות Firestore בשם עבור אפליקציית ברירת המחדל.
getFirestore(app, databaseId) (ביטא) מקבל את שירות Firestore בשם עבור האפליקציה הנתונה.
אתחולFirestore (אפליקציה, הגדרות) מקבל את שירות ברירת המחדל של Firestore עבור האפליקציה הנתונה, ומעביר פרמטרים נוספים לבנאי שלה.
initializeFirestore(אפליקציה, הגדרות, זיהוי מסד נתונים) (ביטא) מקבל את שירות Firestore בשם עבור האפליקציה הנתונה, ומעביר פרמטרים נוספים לבנאי שלה.

ממשקים

מִמְשָׁק תיאור
FirestoreSettings הגדרות להעביר לבנאי Firestore.

getFirestore()

מקבל את שירות ברירת המחדל של Firestore עבור אפליקציית ברירת המחדל.

חֲתִימָה:

export declare function getFirestore(): Firestore;

החזרות:

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

שירות ברירת המחדל של 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

שירות 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

שירות Firestore בעל השם המשויך לאפליקציה שסופקה.

דוגמא

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

initializeFirestore()

מקבל את שירות ברירת המחדל של Firestore עבור האפליקציה הנתונה, ומעביר פרמטרים נוספים לבנאי שלה.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר סוּג תיאור
אפליקציה אפליקציה איזה שירות Firestore להחזיר.
הגדרות FirestoreSettings אובייקט הגדרות שיועבר לבנאי.

החזרות:

Firestore

שירות ברירת המחדל Firestore המשויך לאפליקציה ולהגדרות שסופקו.

דוגמא

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

initializeFirestore()

ממשק API זה מסופק כתצוגה מקדימה למפתחים ועשוי להשתנות בהתאם למשוב שנקבל. אל תשתמש ב-API זה בסביבת ייצור.

מקבל את שירות Firestore בשם עבור האפליקציה הנתונה, ומעביר פרמטרים נוספים לבנאי שלה.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר סוּג תיאור
אפליקציה אפליקציה איזה שירות Firestore להחזיר.
הגדרות FirestoreSettings אובייקט הגדרות שיועבר לבנאי.
מזהה מסד נתונים חוּט שם מסד הנתונים שיש להחזיר.

החזרות:

Firestore

שירות Firestore בעל השם המשויך לאפליקציה ולהגדרות שסופקו.

דוגמא

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

ייצוא מחדש של API חיצוני

ממשקי ה-API המוגדרים חיצונית הבאים מיוצאים מחדש מנקודת הכניסה של המודול הזה מטעמי נוחות.

סֵמֶל תיאור
BulkWriter סוג BulkWriter מחבילת @google-cloud/firestore .
שדה מצטבר סוג AggregateField מחבילת @google-cloud/firestore .
BulkWriterOptions סוג BulkWriterOptions מחבילת @google-cloud/firestore .
BundleBuilder סוג BundleBuilder מחבילת @google-cloud/firestore .
CollectionGroup סוג CollectionGroup מחבילת @google-cloud/firestore .
הפניה לאוסף סוג CollectionReference מחבילת @google-cloud/firestore .
שינוי מסמך סוג DocumentChange מחבילת @google-cloud/firestore .
DocumentData סוג DocumentData מחבילת @google-cloud/firestore .
הפניה למסמך סוג DocumentReference מחבילת @google-cloud/firestore .
DocumentSnapshot סוג DocumentSnapshot מחבילת @google-cloud/firestore .
FieldPath סוג FieldPath מחבילת @google-cloud/firestore .
FieldValue סוג FieldValue מחבילת @google-cloud/firestore .
לְסַנֵן סוג Filter מחבילת @google-cloud/firestore .
Firestore סוג Firestore מחבילת @google-cloud/firestore .
FirestoreDataConverter סוג FirestoreDataConverter מחבילת @google-cloud/firestore .
GeoPoint סוג GeoPoint מחבילת @google-cloud/firestore .
GrpcStatus סוג GrpcStatus מחבילת @google-cloud/firestore .
תְנַאִי מוּקדָם סוג Precondition מחבילת @google-cloud/firestore .
שאילתא סוג Query מחבילת @google-cloud/firestore .
QueryDocumentSnapshot סוג QueryDocumentSnapshot מחבילת @google-cloud/firestore .
QueryPartition סוג QueryPartition מחבילת @google-cloud/firestore .
QuerySnapshot סוג QuerySnapshot מחבילת @google-cloud/firestore .
אפשרויות קריאה סוג ReadOptions מחבילת @google-cloud/firestore .
הגדר אפשרויות סוג SetOptions מחבילת @google-cloud/firestore .
חותמת זמן סוג Timestamp @google-cloud/firestore .
עִסקָה סוג Transaction מחבילת @google-cloud/firestore .
WriteBatch סוג WriteBatch מחבילת @google-cloud/firestore .
כתוב תוצאה סוג WriteResult מחבילת @google-cloud/firestore .
setLogFunction פונקציית setLogFunction מחבילת @google-cloud/firestore .

Cloud Firestore.

פונקציות

פוּנקצִיָה תיאור
getFirestore() מקבל את שירות ברירת המחדל של Firestore עבור אפליקציית ברירת המחדל.
getFirestore(אפליקציה) מקבל את שירות ברירת המחדל של Firestore עבור האפליקציה הנתונה.
getFirestore(databaseId) (ביטא) מקבל את שירות Firestore בשם עבור אפליקציית ברירת המחדל.
getFirestore(אפליקציה, databaseId) (ביטא) מקבל את שירות Firestore בשם עבור האפליקציה הנתונה.
אתחולFirestore (אפליקציה, הגדרות) מקבל את שירות ברירת המחדל של Firestore עבור האפליקציה הנתונה, ומעביר פרמטרים נוספים לבנאי שלה.
initializeFirestore (אפליקציה, הגדרות, databaseId) (ביטא) מקבל את שירות Firestore בשם עבור האפליקציה הנתונה, ומעביר פרמטרים נוספים לבנאי שלה.

ממשקים

מִמְשָׁק תיאור
FirestoreSettings הגדרות להעביר לבנאי Firestore.

getFirestore()

מקבל את שירות ברירת המחדל של Firestore עבור אפליקציית ברירת המחדל.

חֲתִימָה:

export declare function getFirestore(): Firestore;

החזרות:

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

שירות ברירת המחדל של 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

שירות 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

שירות Firestore בעל השם המשויך לאפליקציה שסופקה.

דוגמא

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

initializeFirestore()

מקבל את שירות ברירת המחדל של Firestore עבור האפליקציה הנתונה, ומעביר פרמטרים נוספים לבנאי שלה.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר סוּג תיאור
אפליקציה אפליקציה איזה שירות Firestore להחזיר.
הגדרות FirestoreSettings אובייקט הגדרות שיועבר לבנאי.

החזרות:

Firestore

שירות ברירת המחדל Firestore המשויך לאפליקציה ולהגדרות שסופקו.

דוגמא

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

initializeFirestore()

ממשק API זה מסופק כתצוגה מקדימה למפתחים ועשוי להשתנות בהתאם למשוב שנקבל. אל תשתמש ב-API זה בסביבת ייצור.

מקבל את שירות Firestore בשם עבור האפליקציה הנתונה, ומעביר פרמטרים נוספים לבנאי שלה.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר סוּג תיאור
אפליקציה אפליקציה איזה שירות Firestore להחזיר.
הגדרות FirestoreSettings אובייקט הגדרות שיועבר לבנאי.
מזהה מסד נתונים חוּט שם מסד הנתונים שיש להחזיר.

החזרות:

Firestore

שירות Firestore בעל השם המשויך לאפליקציה ולהגדרות שסופקו.

דוגמא

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