diff --git a/docs/classes/FirebaseEngine.FirebaseEngine.html b/docs/classes/FirebaseEngine.FirebaseEngine.html index 6aab59a3..4a126472 100644 --- a/docs/classes/FirebaseEngine.FirebaseEngine.html +++ b/docs/classes/FirebaseEngine.FirebaseEngine.html @@ -1,17 +1,17 @@ -
Firebase Engine to copy data
+settings object
-Private
adminfirebase app
-Firebase Engine Jobs
-Private
settingssettings object
-Private
storeGoogle cloud storage app
-Jobs Class
-Jobs Class
+firebase app
-backup jobs
-clean jobs
-restore jobs
-settings object
-Google cloud storage app
-Job backup
-Job backup
+firebase app
-Private
authfirebase auth app
-operation counter
-settings object
-start timestamp
-Google cloud storage app
-object to string stream
-Writer streams in object
-Private
recursiveJob backup
-Job backup
+firebase app
-operation counter
-Private
firestorefirebase firestore app
-settings object
-start timestamp
-Google cloud storage app
-object to string stream
-Writer streams in object
-Private
documentbackup one document function
-Private
recursiveJob backup
-Job backup
+firebase app
-operation counter
-settings object
-start timestamp
-Google cloud storage app
-object to string stream
-Writer streams in object
-Private
backupJob class
-Job class
+firebase app
-Private
authfirebase auth app
-operation counter
-settings object
-start timestamp
-Google cloud storage app
-Private
recursiveJob class
-Job class
+firebase app
-Private
batchbatch object
-operation counter
-Private
firestorefirebase firestore app
-settings object
-start timestamp
-Google cloud storage app
-Static
Private
batchdocument on one batch
-Private
batchcommit batch and recreate
-Private
recursiveJob class
-Job class
+firebase app
-operation counter
-settings object
-start timestamp
-Google cloud storage app
-Job restore
-Job restore
+firebase app
-Private
authfirebase auth app
-operation counter
-file read stream
-Optional
gunzipunzip stream
-string to object stream
-settings object
-start timestamp
-Google cloud storage app
-Private
writebuffer for write to project
+firebase app
+Private
authfirebase auth app
+operation counter
+file read stream
+Optional
gunzipunzip stream
+string to object stream
+settings object
+start timestamp
+Google cloud storage app
+Private
writebuffer for write to project
array of user
batch size
clean this buffer
write this buffer to project and clean it
iteration
add user to this buffer
-Private
writewrite user to project stream
-Job restore
-Job restore
+firebase app
-operation counter
-file read stream
-Private
firestorefirebase firestore app
-Optional
gunzipunzip stream
-string to object stream
-settings object
-start timestamp
-Google cloud storage app
-Private
writebuffer for write to project
+firebase app
+operation counter
+file read stream
+Private
firestorefirebase firestore app
+Optional
gunzipunzip stream
+string to object stream
+settings object
+start timestamp
+Google cloud storage app
+Private
writebuffer for write to project
Firestore Writebatch
batch size
clean this buffer
write this buffer to project and clean it
iteration
add document to this buffer
-Private
writewrite document to project stream
-Job restore
-Job restore
+firebase app
-Private
bucketsArray of google storage bucket name
-operation counter
-file read stream
-Optional
gunzipunzip stream
-string to object stream
-settings object
-start timestamp
-Google cloud storage app
-Private
writewrite file to project stream
-Auth Document converter
-Auth Document converter
+Static
Private
userCopy only the allowed fields, otherwise the object breaks inside firebase.auth (after recovery)
-Static
fromStatic
fromStatic
toStatic
toConvert an object to a string
Object for convert
-Auth service bound to the provided app. +
Auth service bound to the provided app. An Auth instance can have multiple tenants.
Optional
checkRevoked: booleanA promise fulfilled with the session cookie's decoded claims if the session cookie is valid; otherwise, a rejected promise.
-Represents a user.
+Represents a user.
Readonly
uidThe user's uid
.
A DocumentReference
refers to a document location in a Firestore database
+
A DocumentReference
refers to a document location in a Firestore database
and can be used to write, read, or listen to the location. The document at
the referenced location may or may not exist. A DocumentReference
can
also be used to create a CollectionReference
to a subcollection.
Converts objects to and from Firestore. Passing in
null
removes the current converter.
A DocumentReference that uses the provided converter.
-Firestore
represents a Firestore Database and is the entry point for all
+
An immutable object representing a geo point in Firestore. The geo point +
An immutable object representing a geo point in Firestore. The geo point is represented as latitude/longitude pair.
Latitude values are in the range of [-90, 90]. Longitude values are in the range of [-180, 180].
@@ -13,7 +13,7 @@Readonly
latitudeReadonly
longitudeReturns true if this GeoPoint
is equal to the provided one.
The GeoPoint
to compare against.
true if this GeoPoint
is equal to the provided one.
A Timestamp represents a point in time independent of any time zone or +
A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is @@ -50,7 +50,7 @@ given number of milliseconds.
Static
nowA write batch, used to perform multiple writes as a single atomic unit.
+A write batch, used to perform multiple writes as a single atomic unit.
A WriteBatch
object can be acquired by calling Firestore.batch()
. It
provides methods for adding writes to the write batch. None of the
writes will be committed (or visible locally) until WriteBatch.commit()
@@ -59,7 +59,7 @@
update.
This WriteBatch
instance. Used for chaining method calls.
Error If the provided input is not valid Firestore data.
-The default Storage
service if no
+
The default Storage
service if no
app is provided or the Storage
service associated with the provided
app.
A Bucket
instance as defined in the @google-cloud/storage
package.
Firestore Document converter
-Firestore Document converter
+Static
Private
fromStatic
fromStatic
fromStatic
Private
toStatic
Private
toStatic
toStatic
toLogger class
-Storage File converter
-Storage File converter
+Static
fromStatic
toStatic
toWriter Class for create write streams
-Job restore
-Job restore
+firebase app
-operation counter
-file read stream
-Optional
gunzipunzip stream
-string to object stream
-settings object
-start timestamp
-Google cloud storage app
-Job backup
-Job backup
+firebase app
-operation counter
-settings object
-start timestamp
-Google cloud storage app
-object to string stream
-Writer streams in object
-Job class
-Job class
+firebase app
-operation counter
-settings object
-start timestamp
-Google cloud storage app
-Job One Template Class
-Job One Template Class
+firebase app
-settings object
-Google cloud storage app
-Job Template Class
-Job Template Class
+firebase app
-settings object
-Google cloud storage app
-Returns a credential created from the +
Returns a credential created from the Google Application Default Credentials that grants admin access to Firebase services. This credential can be used in the call to firebase-admin.app#initializeApp.
@@ -13,7 +13,7 @@ Application Default Credentials that can be used to initialize an app.admin.initializeApp({
credential: admin.credential.applicationDefault(),
databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});
-Returns a credential created from the provided service account that grants +
Returns a credential created from the provided service account that grants admin access to Firebase services. This credential can be used in the call to firebase-admin.app#initializeApp.
See @@ -14,7 +14,7 @@
// Providing a service account object inline
admin.initializeApp({
credential: admin.credential.cert({
projectId: "<PROJECT_ID>",
clientEmail: "foo@<PROJECT_ID>.iam.gserviceaccount.com",
privateKey: "-----BEGIN PRIVATE KEY-----<KEY>-----END PRIVATE KEY-----\n"
}),
databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});
-Returns a credential created from the provided refresh token that grants +
Returns a credential created from the provided refresh token that grants admin access to Firebase services. This credential can be used in the call to firebase-admin.app#initializeApp.
See @@ -13,7 +13,7 @@ provided service account that can be used to initialize an app.
// Providing a path to a refresh token JSON file
var refreshToken = require("path/to/refreshToken.json");
admin.initializeApp({
credential: admin.credential.refreshToken(refreshToken),
databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});
-Gets the Auth service for the default app or a +
Gets the default Firestore +
Gets the default Firestore service for the default app.
The default Firestore service for the default app.
@@ -26,7 +26,7 @@ service associated with the provided app.// Get the Firestore service for a named database and specific app.
const otherFirestore = getFirestore('otherDb');
-Gets the Storage service for the default app or a given app.
+Gets the Storage service for the default app or a given app.
getStorage()
can be called with no arguments to access the default
app's Storage
service or as getStorage(app)
to access the
Storage
service associated with a specific app.
// Get the Storage service for a given app
const otherStorage = getStorage(otherApp);
-Command Line Parser
-Command Line Parser
+Create write stream
+App initialization
+
Firebase Engine to copy data
-