firebase-data-connect
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.
- Installs
- 169.3K
- Last 24h
- +495
- Trending rank
- #701
- Security
- Fail
Install
Works with every agent the skills CLI supports.
npx skills add https://github.com/firebase/agent-skills --skill firebase-data-connect- 01
Install
Run the command in your project. The CLI asks which agents to install for.
- 02
Describe the task
Ask your agent for something this skill covers. It loads firebase-data-connect automatically when relevant.
- 03
Review the result
The agent follows the SKILL.md steps, scripts and references bundled with the skill.
Security audits
Independent scans of the skill's instructions and bundled files.
SKILL.md
The instructions your agent reads when the skill is triggered.
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:
- Review GraphQL Schema: Both user-defined and generated extensions (in
.dataconnect/schema/main/). - Validate Operations: Run
npx -y firebase-tools@latest dataconnect:compileagainst 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.
| Strategy | When to use | Implementation |
|---|---|---|
| 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 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 for:
- Queries: Filtering (
where), Ordering (orderBy), Pagination (limit/offset).- Mutations: Create (
_insert), Update (_update), Delete (_delete).- Upserts: Use
_upsertto "insert or update" records (CRITICAL for user profiles).- Transactions: Use
@transactionfor multi-step atomic operations. Use_expr: "response.<prevStep>"to pass data between steps.Read reference/security.md for authorization:
@auth(level: ...)for PUBLIC, USER, or NO_ACCESS.@checkand@redactfor row-level security and validation.Read reference/realtime.md for real-time subscriptions:
@refreshdirective for time-based polling and event-driven updates.- CEL conditions to scope refresh triggers precisely.
Read 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
- Android (Kotlin): reference/sdk_android.md
- iOS (Swift): reference/sdk_ios.md
- Admin (Node.js): reference/sdk_admin_node.md
- Flutter (Dart): reference/sdk_flutter.md
Feature Capability Map
If you need to implement a specific feature, consult the mapped reference file:
| Feature | Reference File | Key Concepts |
|---|---|---|
| Data Modeling | reference/schema.md | @table, @unique, @index, Relations |
| Vector Search | reference/search.md | Vector, @col(dataType: "vector"), embeddings |
| Full-Text Search | reference/search.md | @searchable, movies_search |
| Upserting Data | reference/operations.md | _upsert mutations |
| Complex Filters | reference/operations.md | _or, _and, _not, eq, contains |
| Transactions | reference/operations.md | @transaction, response binding |
| Environment Config | reference/config.md | dataconnect.yaml, connector.yaml |
| Realtime Subscriptions | reference/realtime.md | @refresh, subscribe(), auto-refresh |
| Cloud Functions Integration | reference/cloud_functions.md | onMutationExecuted, triggering events |
| Data Seeding & Migrations | reference/data_seeding.md | seed_data.gql, _insertMany, Admin SDK bulk |
| Starter Templates | templates.md | CRUD, user-owned resources, many-to-many, SDK init |
Deployment & CLI
Read 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
- Understand the app idea. Ask clarification questions if unclear.
- Run
npx -y firebase-tools@latest init dataconnect. - Validate that the app template and generated SDK are setup.
How to build apps using SQL Connect locally
- Start the emulator:
npx -y firebase-tools@latest emulators:start --only dataconnect. - Write schema and operations.
- Seed local test data into
seed_data.gql. Read reference/data_seeding.md. - Run
npx -y firebase-tools@latest dataconnect:compileornpx -y firebase-tools@latest dataconnect:sdk:generateto validate them. - Use the operations in your app and build it.
How to deploy SQL Connect to Cloud SQL
- Run
npx -y firebase-tools@latest deploy --only dataconnect.
Examples
For complete, working code examples of schemas and operations, see examples.md.
For ready-to-use starter templates (CRUD, user-owned resources, many-to-many, YAML configs, SDK init), see templates.md.
FAQ
What does the firebase-data-connect skill do?
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.
How do I install firebase-data-connect?
Run npx skills add https://github.com/firebase/agent-skills --skill firebase-data-connect in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/firebase-data-connect/ (personal) or .claude/skills/firebase-data-connect/ (project).
Which AI agents can use firebase-data-connect?
Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.
Is firebase-data-connect safe to install?
Security partners have reviewed it: Gen Agent Trust Hub passed; Socket flagged items to review; Snyk passed; Runlayer flagged risks; ZeroLeaks passed. As with any skill, read the SKILL.md and bundled scripts before installing.
Who maintains firebase-data-connect?
It is published by firebase in firebase/agent-skills, and it is an official skill from the maker of the technology it covers. It has 169,281 recorded installs.
More from firebase/agent-skills
firebase-basics
firebase/agent-skills
Provides foundational Firebase CLI setup, CLI installation, version checks (firebase-tools@latest --version), CLI login (including --no-localhost), project creation, project selection (firebase use), and app config file downloads (google-services.json, GoogleService-Info.plist). Use ONLY for CLI login, project creation/switching, or downloading app config files. Don't use for Firebase Hosting deploy, Firestore, Auth, App Hosting, Data Connect, Crashlytics, or Remote Config.
firebase-auth-basics
firebase/agent-skills
Guide for setting up and using Firebase Authentication. Use this skill when the user's app requires user sign-in, user management, or secure data access using auth rules.
firebase-hosting-basics
firebase/agent-skills
Deploys and configures classic Firebase Hosting for static websites, single-page apps (SPAs), and microservices. Use when deploying static sites/SPAs, setting up custom domains, configuring firebase.json hosting settings (redirects, rewrites, headers, multi-site), or managing preview channels. Don't use for Firebase App Hosting (Next.js/SSR), Auth, Firestore queries/rules, Data Connect, or Crashlytics.
firebase-app-hosting-basics
firebase/agent-skills
Deploys and manages full-stack web applications (Next.js, Angular) with Server-Side Rendering (SSR) using Firebase App Hosting. Use when deploying Next.js/Angular apps, configuring apphosting.yaml or firebase.json apphosting blocks, managing secrets, setting up GitHub CI/CD, or configuring Blaze billing requirements. Don't use for classic static web hosting, Auth, Firestore, Crashlytics, or Xcode.
firebase-security-rules-auditor
firebase/agent-skills
Audits Firebase (Firestore, Cloud Storage) security rules for vulnerabilities, privilege escalation, role bypasses, create vs update inconsistencies, resource exhaustion, type safety, size limits, and hasOnly ownership checks. Use when auditing/reviewing rules, running red-team rule assessments, or scoring against auditor checklists. Don't use for Firebase CLI (login, deploy), Auth, Crashlytics, Remote Config, or database queries.
firebase-ai-logic-basics
firebase/agent-skills
Integrates Firebase AI Logic (formerly Vertex AI for Firebase) into mobile and web apps (Android, iOS, Web, and Flutter) to call Gemini models from client code. Use when provisioning or initializing Firebase AI Logic, or adding Gemini features to an app: text generation, multimodal input, chat, streaming, structured output, hybrid on-device inference, App Check protection, or switching models with Remote Config.
Popular data & databases skills
supabase-postgres-best-practices
supabase/agent-skills
Postgres best practices maintained by Supabase, for Postgres running anywhere. Load this skill BEFORE writing or changing anything that lives in a Postgres database: creating or altering tables and columns (including choosing column types), schema design, migrations and declarative schema files, RLS policies and the tests that verify them, indexes, triggers, database functions, queues and scheduled jobs (pgcron, pgmq), vector/semantic search (pgvector), and restoring dumps (pgrestore) or importing data. Also load it when diagnosing slow queries, high CPU, timeouts, EXPLAIN plans, connection exhaustion, locking, bloat, or rows visible to the wrong user or tenant. This is not just a performance guide — schema, migration, security, and SQL authoring tasks need these rules too, even for a one-column change or a single query.
prisma-client-api
prisma/skills
Prisma Client API reference covering model queries, filters, operators, and client methods. Use when writing database queries, using CRUD operations, filtering data, or configuring Prisma Client. Triggers on "prisma query", "findMany", "create", "update", "delete", "$transaction".
prisma-database-setup
prisma/skills
Deprecated compatibility name for prisma-orm-setup. Use only when a user or existing integration explicitly invokes prisma-database-setup; otherwise select prisma-orm-setup.
prisma-cli
prisma/skills
Prisma ORM 7 CLI reference for existing Prisma 7 applications or explicitly selected Prisma 7 workflows. Covers prisma init, generate, migrate, db, dev, studio, and mcp. For setup, connection repair, or Prisma 8, use prisma-orm-setup; not the Prisma Platform CLI.
prisma-postgres
prisma/skills
Deprecated compatibility name for prisma-postgres-setup. Use only when a user or existing integration explicitly invokes prisma-postgres; otherwise select prisma-postgres-setup.
prisma-driver-adapter-implementation
prisma/skills
Required reference for Prisma ORM 7 SQL driver adapter work. Use when implementing or modifying adapters, adding database drivers, or touching SqlDriverAdapter, Transaction, savepoint, result mapping, or DriverAdapterError behavior. Covers current transaction lifecycle, optional savepoint hooks, original database-error preservation, and verification.