如果您要在客户端代码中集成预定义的查询和突变,并且专门使用模拟器来测试客户端,则可以使用 start 选项进行交互式工作。您还可以通过 VS Code 扩展程序启动模拟器。
firebaseemulators:start
对客户端代码进行插桩处理,以便与模拟器通信
按照以下步骤设置您的应用内配置或测试类,以便与 Data Connect 模拟器进行交互。
JavaScript
import{initializeApp}from"firebase/app";import{connectorConfig}from"@name-of-package";import{connectDataConnectEmulator,getDataConnect}from'firebase/data-connect';// TODO: Replace the following with your app's Firebase project configurationconstfirebaseConfig={//...};constapp=initializeApp(firebaseConfig);constdataConnect=getDataConnect(app,connectorConfig);connectDataConnectEmulator(dataConnect,"localhost",9399);// Make calls from your app
Kotlin Android
valconnector=MoviesConnector.instance// Connect to the emulator on "10.0.2.2:9399"connector.dataConnect.useEmulator()// (Alternatively) if you're running your emulator on non-default port:connector.dataConnect.useEmulator(port=9999)// Make calls from your app
iOS
let connector = DataConnect.dataConnect(DefaultConnectorClient.connectorConfig)
// Connect to the emulator on "127.0.0.1:9399"
connector.useEmulator()
// (alternatively) if you're running your emulator on non-default port:
connector.useEmulator(port: 9999)
// Make calls from your app
使用模拟器进行测试和持续集成
运行容器化 Local Emulator Suite 映像
在典型的 CI 设置中,安装和配置使用容器的 Local Emulator Suite 非常简单。
您需要注意以下几个问题:
模拟器二进制文件安装在 ~/.cache/firebase/emulators/ 中并在该目录下缓存。您可能需要将此路径添加到 CI 缓存配置,以免重复下载。
[null,null,["最后更新时间 (UTC):2025-07-25。"],[],[],null,["\u003cbr /\u003e\n\nFirebase Data Connect provides you with a local emulator for end-to-end\nprototyping as well as continuous integration and continuous deployment\n(CI/CD) flows:\n\n- The Data Connect emulator interacts with a local integrated PGLite database instance to let you prototype queries and mutations and test client code in a fully local environment.\n- The Data Connect emulator can also be used for non-interactive work. It lets you run automated tests and is suitable for use with CI/CD workflows. This is useful when your schemas are stable and you want to prototype and test client-side code.\n\nThis guide covers installation and usage of the emulator in more detail than\nthe quickstart.\n\nInstall the Data Connect emulator\n\nBefore installing the Local Emulator Suite to use the Data Connect\nemulator, you will need:\n\n- Node.js version 18.0 or higher.\n\nInstall the Firebase CLI and set up project directory **Note:** If you've followed the [Get started with Firebase Data Connect](/docs/data-connect/quickstart) guide, you can skip this section.\n\n1. Install the Firebase CLI, [following the installation guide](/docs/cli).\n Be sure to [update regularly](/docs/cli#update-cli), since the\n Data Connect emulator is under active development with bug fixes and\n new features.\n\n2. If you haven't already done so, initialize the current working directory as\n a Firebase project, following prompts to specify which products to use:\n\n firebase init\n\nSet or modify the Local Emulator Suite configuration\n\nIf you started the Data Connect emulator from the Firebase VS Code\nextension, the emulator was installed for you, if needed.\n\nYou can use the Firebase CLI to manually install the emulator along with\nother selected components of the Local Emulator Suite. This command starts a\nconfiguration wizard that lets you select emulators of interest, download the\ncorresponding emulator binary files, and set emulator ports if the defaults are\nnot appropriate. \n\n firebase init emulators\n\nOnce an emulator is installed, no update checks are performed and no additional\nautomatic downloads will occur until you update your Firebase CLI version.\n\nChoose a Firebase project\n\nIn the setup flow, the Firebase CLI prompts you to choose or create a\nFirebase project. If you choose an existing project you've set up with\nData Connect in the Firebase console, the configuration you chose\nthere will be suggested.\n\nSet up the emulator **Note:** Usage of the emulator in the Firebase Data Connect VS Code extension is covered in [Get started with Firebase Data Connect](/docs/data-connect/quickstart).\n\nConfigure the emulator\n\nRunning the `firebase init` flow will guide you through emulator setup options.\nLike other emulators in the Local Emulator Suite, configuration parameters\nare stored in local project files.\n\n- Your `firebase.json` file contains emulator port assignments.\n - The `emulators:ui` key does not apply to the Data Connect emulator.\n\nWork with local and production Data Connect resources\n\nIf you want to be sure not to impact production resources, set a `demo-`\nprojectID or make sure your client code is instrumented to connect to\nthe emulator, as discussed in a later section.\n\nStart the emulator\n\nIf you're running the emulator non-interactively, for example for CI/CD\nworkflows, start it with the `exec` option. \n\n firebase emulators:exec ./path/to/test-script.sh\n\nIf you're integrating predefined queries and mutations in client code and are\nusing the emulator specifically for testing clients, you can use the `start`\noption for interactive work. You can also start the emulator from the VS Code\nextension. \n\n firebase emulators:start\n\n| **Note:** When you start the emulator with `firebase emulators:start`, SDK code will be automatically generated just as if you had run `firebase sdk:generate`.\n\nInstrument your client code to talk to the emulator\n\nSet up your in-app configuration or test classes to interact with the\nData Connect emulator as follows. \n\nJavaScript \n\n```javascript\nimport { initializeApp } from \"firebase/app\";\nimport { connectorConfig } from \"@name-of-package\";\nimport { connectDataConnectEmulator, getDataConnect } from 'firebase/data-connect';\n\n// TODO: Replace the following with your app's Firebase project configuration\nconst firebaseConfig = {\n //...\n};\n\nconst app = initializeApp(firebaseConfig);\n\nconst dataConnect = getDataConnect(app, connectorConfig);\nconnectDataConnectEmulator(dataConnect, \"localhost\", 9399);\n\n// Make calls from your app\n \n```\n\nKotlin Android \n\n```kotlin\nval connector = MoviesConnector.instance\n\n// Connect to the emulator on \"10.0.2.2:9399\"\nconnector.dataConnect.useEmulator()\n\n// (Alternatively) if you're running your emulator on non-default port:\nconnector.dataConnect.useEmulator(port = 9999)\n\n// Make calls from your app\n \n```\n\niOS \n\n```text\nlet connector = DataConnect.dataConnect(DefaultConnectorClient.connectorConfig)\n\n// Connect to the emulator on \"127.0.0.1:9399\"\nconnector.useEmulator()\n\n// (alternatively) if you're running your emulator on non-default port:\nconnector.useEmulator(port: 9999)\n\n// Make calls from your app\n \n```\n\nUse the emulator for testing and continuous integration\n\nRun containerized Local Emulator Suite images\n\nInstallation and configuration of the Local Emulator Suite with containers\nin a typical CI setup is straightforward.\n\nThere are a few issues to note:\n\n- Emulator binaries are installed and cached at `~/.cache/firebase/emulators/`. You may want to add this path to your CI cache configuration to avoid repeated downloads.\n- If you don't have a `firebase.json` file in your repository, you must add a command line argument to the `emulators:start` or `emulators:exec` command to specify which emulators should be started. For example, `--only dataconnect`.\n\nClear your database between tests\n\nTo reset your test environments between runs, Firebase recommends:\n\n- Writing dedicated mutations to handle the following:\n - In setup, populate a local database instance with starting data.\n - In teardown, delete modified data from post-test database instance.\n\nHow the Data Connect emulator differs from production\n\nThe Data Connect emulator simulates many features of the server-side\nproduct. However, there are some exceptions to be aware of:\n\n- The version and detailed configuration of PGLite may differ from the version of your production Cloud SQL instance.\n- If you're using the emulator to develop with Data Connect's pgvector and Vertex API integration, calls to the Cloud Vertex API are made directly, rather than through Cloud SQL's Vertex integration. However, calls to the production API are still made, meaning you must use a real Firebase project, cannot use a `demo-` project, and costs of the Vertex API will be incurred."]]