Package net.officefloor.nosql.firestore

Class FirestoreConnect

java.lang.Object

net.officefloor.nosql.firestore.FirestoreConnect

public class FirestoreConnect
extends Object

Firestore connect functionality.

Author:

Daniel Sagenschneider

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FIRESTORE_EMULATOR_HOST	Property name to specify using emulator.
static final String	PROJECT_ID	Property name to specify the Google project Id.

Method Summary

Modifier and Type	Method	Description
static com.google.cloud.firestore.Firestore	connect(SourceContext context)	Connects to Firestore.
static void	setFirestoreFactory(FirestoreFactory firestoreFactory)	Sets using the FirestoreFactory.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PROJECT_ID

public static final String PROJECT_ID

Property name to specify the Google project Id.

See Also:

• Constant Field Values

FIRESTORE_EMULATOR_HOST

public static final String FIRESTORE_EMULATOR_HOST

Property name to specify using emulator.

See Also:

• Constant Field Values

Method Details

setFirestoreFactory

public static void setFirestoreFactory(FirestoreFactory firestoreFactory)

Sets using the FirestoreFactory.

This is typically used for testing to allow overriding the FirestoreFactory being used.

Parameters:

firestoreFactory - FirestoreFactory. May be null to not override.

connect

public static com.google.cloud.firestore.Firestore connect(SourceContext context)
                                                    throws Exception

Connects to Firestore.

Note that the Firestore instance is not managed. It will need to be manually shutdown once use is complete.

Parameters:

context - SourceContext.

Returns:

Firestore.

Throws:

Exception - If fails to connect.