Firebase Data Connect

Project Structure

dataconnect/
├── dataconnect.yaml      # Service configuration
├── schema/
│   └── schema.gql        # Data model (types with @table)
└── connector/
    ├── connector.yaml    # Connector config + SDK generation
    ├── queries.gql       # Queries
    └── mutations.gql     # Mutations

Development Workflow

1. Define Data Model (

schema/schema.gql

)

Read reference/schema.md for:

• @table

  ,

  @col

  ,

  @default

• Relationships (

  @ref

  , one-to-many, many-to-many)
• Data types (UUID, Vector, JSON, etc.)

2. Define Operations (

connector/queries.gql

,

connector/mutations.gql

)

Read 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.

3. Secure Your App (

connector/

files)

Read reference/security.md for:

• @auth(level: ...)

  for PUBLIC, USER, or NO_ACCESS.

• @check

  and

  @redact

  for row-level security and validation.

4. Generate & Use SDKs

Read reference/sdks.md for:

• Android (Kotlin), iOS (Swift), Web (TypeScript), Flutter (Dart).
• How to initialize and call your queries/mutations.
• Nested Data: See how to access related fields (e.g.,

  movie.reviews

  ).

Feature Capability Map

@table

@unique

@index

Vector

@col(dataType: "vector")

@searchable

_upsert

_or

_and

_not

eq

contains

@transaction

response

dataconnect.yaml

connector.yaml

Deployment & CLI

Read reference/config.md for deep dive on configuration.

# Initialize Data Connect
firebase init dataconnect

# Start local emulator
firebase emulators:start --only dataconnect

# Generate SDK code
firebase dataconnect:sdk:generate

# Deploy to production
firebase deploy --only dataconnect

Examples