Skip to content
Firebase SQL Connect (Data Connect)

Firebase SQL Connect (Data Connect) Skill

Firebase's official skill for building and deploying Firebase SQL Connect (formerly Data Connect) backends on Cloud SQL for PostgreSQL: GraphQL schemas, authorized queries and mutations, realtime updates and generated type-safe SDKs.

GitHub Docs

Install

Install with the skills CLI

One command for Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf and dozens of other agents. Needs Node.js; the skill is fetched straight from firebase/agent-skills.

$ npx skills add firebase/agent-skills --skill firebase-data-connect

Run it in a terminal. The CLI finds the agents installed on your machine, asks which ones to add the skill to, and whether to install it into the folder you ran it from or for all your projects.

Other ways to install

  1. Open the skill on GitHub and download the folder that holds its SKILL.md.
  2. Put it at ~/.claude/skills/firebase-data-connect/, where Claude Code picks it up in every project.

No scripts or references next to it? Saving the SKILL.md alone as ~/.claude/skills/firebase-data-connect/SKILL.md works too.

Using another agent? Its personal skills folder
Codex
~/.agents/skills/
Cursor
~/.cursor/skills/
GitHub Copilot
~/.copilot/skills/
Gemini CLI
~/.gemini/skills/
Windsurf
~/.codeium/windsurf/skills/
OpenCode
~/.config/opencode/skills/

About

  • Schema-first workflow: schema.gql, authorized queries and mutations, generated SDKs
  • Type-safe SDK generation for web, Android, iOS, Flutter and the Node.js Admin SDK
  • Native GraphQL by default, native SQL only for PostGIS, window functions and similar
  • References for vector and full-text search, transactions, realtime and Cloud Functions triggers
  • Local emulator, compile validation and deploy commands via firebase-tools

Firebase SQL Connect is the relational database skill in the firebase/agent-skills repository, written by Google. It teaches an agent to build backends on Firebase SQL Connect, the service previously called Firebase Data Connect, which puts a GraphQL schema with generated queries and mutations in front of Cloud SQL for PostgreSQL. The agent uses it whenever an app needs a relational database with Firebase or the user mentions SQL Connect or Data Connect.

It lays out the dataconnect/ project structure and a strict three-step workflow: model the data in schema/schema.gql with @table, @unique, @index and relations; write the client's queries and mutations with their authorization rules in the connector files, since the service is secure by default; and generate type-safe SDKs for web (TypeScript), Android (Kotlin), iOS (Swift), Flutter and the Node.js Admin SDK from connector.yaml. Native GraphQL is the default; native SQL is reserved for explicit requests or advanced features such as PostGIS, window functions and complex aggregations, because it gives up type safety.

A capability map points to reference files for vector and full-text search, upserts, complex filters, transactions, realtime subscriptions, Cloud Functions triggers and data seeding. The CLI recipes cover firebase init dataconnect, the local emulator, validating with dataconnect:compile, and firebase deploy --only dataconnect. Requires Node.js (it runs firebase-tools through npx) and a Firebase project. Apache-2.0 licensed.

SKILL.md

The instructions your agent loads, as published by Firebase.

SKILL.md
name
firebase-data-connect
description
Builds and deploys Firebase SQL Connect (aka Firebase Data Connect) backends with PostgreSQL securely. Use when designing schemas with tables and relations, writing authorized queries and mutations, configuring real-time data updates, or generating type-safe SDKs. Use when you need a relational database with Firebase, or when the user mentions SQL Connect or Data Connect.
metadata
author: Google LLC category: Databases

Firebase SQL Connect

Firebase SQL Connect is a relational database service using Cloud SQL for
PostgreSQL with GraphQL schema, auto-generated queries/mutations, and type-safe
SDKs.

[!NOTE] Product Rename: Firebase Data Connect was renamed to **Firebase
SQL Connect**. All instructions, references, and examples in this skill
repository referring to "Data Connect" or "Firebase Data Connect" apply to
"SQL Connect" and "Firebase SQL Connect" as well.
Project Structure
dataconnect/
├── dataconnect.yaml      # Service configuration
├── seed_data.gql         # LOCAL ONLY — prototype/test data
├── schema/
│   └── schema.gql        # Data model (types with @table)
└── connector/
    ├── connector.yaml    # Connector config + SDK generation
    ├── queries.gql       # Queries
    └── mutations.gql     # Mutations
Key Tools for Validation

Rely on these two mechanisms to ensure project correctness:

  1. Review GraphQL Schema: Both user-defined and generated extensions (in

.dataconnect/schema/main/).

  1. Validate Operations: Run

npx -y firebase-tools@latest dataconnect:compile against the schema.

Operation Strategies: GraphQL vs. Native SQL

Always default to Native GraphQL. Native SQL lacks type safety and
bypasses schema-enforced structures. Only use Native SQL when the user
explicitly requests it or when the task requires advanced database features.

StrategyWhen to useImplementation
Native GraphQL (Default)Almost all use cases. Standard CRUD, basic filtering/sorting, simple relational joins. Requires full type safety.Auto-generated fields (movie_insert, movies). Strong typing and schema enforcement.
Native SQL (Advanced)PostgreSQL extensions (e.g., PostGIS), window functions (RANK()), complex aggregations, or highly tuned sub-queries.Raw SQL string literals via _select, _execute, etc. Requires strict positional parameters ($1). No type safety.
Development Workflow

Follow this strict workflow to build your application. You must read the
linked reference files for each step to understand the syntax and available
features.

1. Define Data Model (schema/schema.gql)

Define your GraphQL types, tables, and relationships (which map to a Postgres
schema).

Read [reference/schema.md](reference/schema.md) for:

- @table, @col, @default
- Relationships (@ref, one-to-many, many-to-many)
- Data types (UUID, Vector, JSON, etc.)
2. Define Authorized Operations (connector/queries.gql, connector/mutations.gql)

Write the queries and mutations your client will use, including authorization
logic. SQL Connect is secure by default.

Read [reference/operations.md](reference/operations.md) for:

- Queries: Filtering (where), Ordering (orderBy), Pagination
(limit/offset).
- Mutations: Create (_insert), Update (_update), Delete (_delete).
- Upserts: Use _upsert to "insert or update" records (CRITICAL for user
profiles).
- Transactions: Use @transaction for multi-step atomic operations. Use
_expr: "response.<prevStep>" to pass data between steps.

Read [reference/security.md](reference/security.md) for authorization:

- @auth(level: ...) for PUBLIC, USER, or NO_ACCESS.
- @check and @redact for row-level security and validation.

Read [reference/realtime.md](reference/realtime.md) for real-time
subscriptions:

- @refresh directive for time-based polling and event-driven updates.
- CEL conditions to scope refresh triggers precisely.

Read [reference/native_sql.md](reference/native_sql.md) for Native SQL
operations:

- Embedding raw SQL with _select, _selectFirst, _execute
- Strict rules for positional parameters ($1, $2), quoting, and CTEs
- Advanced PostgreSQL features (PostGIS, Window Functions)
3. Use type-safe SDK in your apps

Generate type-safe code for your client platform.

Configure SDK generation in connector.yaml:

connectorId: my-connector
generate:
  javascriptSdk:
    outputDir: "../web-app/src/lib/dataconnect"
    package: "@movie-app/dataconnect"
  kotlinSdk:
    outputDir: "../android-app/app/src/main/kotlin/com/example/dataconnect"
    package: "com.example.dataconnect"
  swiftSdk:
    outputDir: "../ios-app/DataConnect"
    package: "DataConnectGenerated"

Generate SDKs:

npx -y firebase-tools@latest dataconnect:sdk:generate

For platform-specific instructions on how to use the generated SDKs, read:

  • Web (TypeScript): [reference/sdk_web.md](reference/sdk_web.md)
  • Android (Kotlin): [reference/sdk_android.md](reference/sdk_android.md)
  • iOS (Swift): [reference/sdk_ios.md](reference/sdk_ios.md)
  • Admin (Node.js):

[reference/sdk_admin_node.md](reference/sdk_admin_node.md)

  • Flutter (Dart): [reference/sdk_flutter.md](reference/sdk_flutter.md)

______________________________________________________________________

Feature Capability Map

If you need to implement a specific feature, consult the mapped reference file:

FeatureReference FileKey Concepts
Data Modeling[reference/schema.md](reference/schema.md)@table, @unique, @index, Relations
Vector Search[reference/search.md](reference/search.md)Vector, @col(dataType: "vector"), embeddings
Full-Text Search[reference/search.md](reference/search.md)@searchable, movies_search
Upserting Data[reference/operations.md](reference/operations.md)_upsert mutations
Complex Filters[reference/operations.md](reference/operations.md)_or, _and, _not, eq, contains
Transactions[reference/operations.md](reference/operations.md)@transaction, response binding
Environment Config[reference/config.md](reference/config.md)dataconnect.yaml, connector.yaml
Realtime Subscriptions[reference/realtime.md](reference/realtime.md)@refresh, subscribe(), auto-refresh
Cloud Functions Integration[reference/cloud_functions.md](reference/cloud_functions.md)onMutationExecuted, triggering events
Data Seeding & Migrations[reference/data_seeding.md](reference/data_seeding.md)seed_data.gql, _insertMany, Admin SDK bulk
Starter Templates[templates.md](templates.md)CRUD, user-owned resources, many-to-many, SDK init

______________________________________________________________________

Deployment & CLI
Read [reference/config.md](reference/config.md) for deep dive on
configuration.

Follow these patterns based on your current task:

How to initialize SQL Connect in a Firebase project
  1. Understand the app idea. Ask clarification questions if unclear.
  2. Run npx -y firebase-tools@latest init dataconnect.
  3. Validate that the app template and generated SDK are setup.
How to build apps using SQL Connect locally
  1. Start the emulator:

npx -y firebase-tools@latest emulators:start --only dataconnect.

  1. Write schema and operations.
  2. Seed local test data into seed_data.gql. Read

[reference/data_seeding.md](reference/data_seeding.md#1-local-prototyping-data-seeding).

  1. Run npx -y firebase-tools@latest dataconnect:compile or

npx -y firebase-tools@latest dataconnect:sdk:generate to validate them.

  1. Use the operations in your app and build it.
How to deploy SQL Connect to Cloud SQL
  1. Run npx -y firebase-tools@latest deploy --only dataconnect.
Examples

For complete, working code examples of schemas and operations, see
[examples.md](examples.md).

For ready-to-use starter templates (CRUD, user-owned resources, many-to-many,
YAML configs, SDK init), see [templates.md](templates.md).

Install

Prisma's official skill for getting an app a Prisma Postgres database: reuse an existing connection, use the Vercel Marketplace flow, spin up a no-account database with npx create-db, or provision a persistent one, then connect and verify it.

New

Prisma's official skill for setting up Prisma ORM or repairing an app's database connection: it detects the app's Prisma version, defaults new apps to Prisma 8 and its package-owned skill, and keeps Prisma 6 and 7 apps on their own major.

New

Firebase's official skill for Cloud Firestore: it detects or creates the database, picks the Standard or Enterprise edition guides, and covers provisioning, data modelling, indexes, security rules and SDK setup for Web, Python, iOS, Android and Flutter.

Browse all skills →