firebase-admin.data-connect package
Stay organized with collections
Save and categorize content based on your preferences.
Firebase Data Connect service.
Functions
| Function |
Description |
| getDataConnect(connectorConfig, app) |
Gets the DataConnect service with the provided connector configuration for the default app or a given app.getDataConnect(connectorConfig) can be called with no app argument to access the default app's DataConnect service or as getDataConnect(connectorConfig, app) to access the DataConnect service associated with a specific app. |
Classes
| Class |
Description |
| DataConnect |
The Firebase DataConnect service interface. |
Interfaces
Type Aliases
| Type Alias |
Description |
| AuthClaims |
Type representing the partial claims of a Firebase Auth token used to evaluate the Data Connect auth policy. |
getDataConnect(connectorConfig, app)
Gets the DataConnect service with the provided connector configuration for the default app or a given app.
getDataConnect(connectorConfig) can be called with no app argument to access the default app's DataConnect service or as getDataConnect(connectorConfig, app) to access the DataConnect service associated with a specific app.
Signature:
export declare function getDataConnect(connectorConfig: ConnectorConfig, app?: App): DataConnect;
Parameters
| Parameter |
Type |
Description |
| connectorConfig |
ConnectorConfig |
Connector configuration for the DataConnect service. |
| app |
App |
Optional app for which to return the DataConnect service. If not provided, the default DataConnect service is returned. |
Returns:
DataConnect
The default DataConnect service with the provided connector configuration if no app is provided, or the DataConnect service associated with the provided app.
Example 1
const connectorConfig: ConnectorConfig = {
location: 'us-west2',
serviceId: 'my-service',
};
// Get the `DataConnect` service for the default app
const defaultDataConnect = getDataConnect(connectorConfig);
Example 2
// Get the `DataConnect` service for a given app
const otherDataConnect = getDataConnect(connectorConfig, otherApp);
AuthClaims
Type representing the partial claims of a Firebase Auth token used to evaluate the Data Connect auth policy.
Signature:
export type AuthClaims = Partial<DecodedIdToken>;
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-05 UTC.
[null,null,["Last updated 2025-03-05 UTC."],[],[],null,["# firebase-admin.data-connect package\n\nFirebase Data Connect service.\n\nFunctions\n---------\n\n| Function | Description |\n|-------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [getDataConnect(connectorConfig, app)](./firebase-admin.data-connect.md#getdataconnect_3887e80) | Gets the [DataConnect](./firebase-admin.data-connect.dataconnect.md#dataconnect_class) service with the provided connector configuration for the default app or a given app.`getDataConnect(connectorConfig)` can be called with no app argument to access the default app's `DataConnect` service or as `getDataConnect(connectorConfig, app)` to access the `DataConnect` service associated with a specific app. |\n\nClasses\n-------\n\n| Class | Description |\n|-------------------------------------------------------------------------------|-----------------------------------------------|\n| [DataConnect](./firebase-admin.data-connect.dataconnect.md#dataconnect_class) | The Firebase `DataConnect` service interface. |\n\nInterfaces\n----------\n\n| Interface | Description |\n|--------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------|\n| [ConnectorConfig](./firebase-admin.data-connect.connectorconfig.md#connectorconfig_interface) | Interface representing a Data Connect connector configuration. |\n| [ExecuteGraphqlResponse](./firebase-admin.data-connect.executegraphqlresponse.md#executegraphqlresponse_interface) | Interface representing GraphQL response. |\n| [GraphqlOptions](./firebase-admin.data-connect.graphqloptions.md#graphqloptions_interface) | Interface representing GraphQL options. |\n| [ImpersonateAuthenticated](./firebase-admin.data-connect.impersonateauthenticated.md#impersonateauthenticated_interface) | Interface representing the impersonation of an authenticated user. |\n| [ImpersonateUnauthenticated](./firebase-admin.data-connect.impersonateunauthenticated.md#impersonateunauthenticated_interface) | Interface representing the impersonation of an unauthenticated user. |\n\nType Aliases\n------------\n\n| Type Alias | Description |\n|-----------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|\n| [AuthClaims](./firebase-admin.data-connect.md#authclaims) | Type representing the partial claims of a Firebase Auth token used to evaluate the Data Connect auth policy. |\n\ngetDataConnect(connectorConfig, app)\n------------------------------------\n\nGets the [DataConnect](./firebase-admin.data-connect.dataconnect.md#dataconnect_class) service with the provided connector configuration for the default app or a given app.\n\n`getDataConnect(connectorConfig)` can be called with no app argument to access the default app's `DataConnect` service or as `getDataConnect(connectorConfig, app)` to access the `DataConnect` service associated with a specific app.\n\n**Signature:** \n\n export declare function getDataConnect(connectorConfig: ConnectorConfig, app?: App): DataConnect;\n\n### Parameters\n\n| Parameter | Type | Description |\n|-----------------|-----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|\n| connectorConfig | [ConnectorConfig](./firebase-admin.data-connect.connectorconfig.md#connectorconfig_interface) | Connector configuration for the `DataConnect` service. |\n| app | App | Optional app for which to return the `DataConnect` service. If not provided, the default `DataConnect` service is returned. |\n\n**Returns:**\n\n[DataConnect](./firebase-admin.data-connect.dataconnect.md#dataconnect_class)\n\nThe default `DataConnect` service with the provided connector configuration if no app is provided, or the `DataConnect` service associated with the provided app.\n\n### Example 1\n\n const connectorConfig: ConnectorConfig = {\n location: 'us-west2',\n serviceId: 'my-service',\n };\n\n // Get the `DataConnect` service for the default app\n const defaultDataConnect = getDataConnect(connectorConfig);\n\n### Example 2\n\n // Get the `DataConnect` service for a given app\n const otherDataConnect = getDataConnect(connectorConfig, otherApp);\n\nAuthClaims\n----------\n\nType representing the partial claims of a Firebase Auth token used to evaluate the Data Connect auth policy.\n\n**Signature:** \n\n export type AuthClaims = Partial\u003cDecodedIdToken\u003e;"]]
