Google

Firebase SQL Connect API

Firebase SQL Connect is a relational database service for mobile and web apps that lets you build and scale using a fully-managed PostgreSQL database powered…

Communication#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Firebase SQL Connect is a relational database service for mobile and web apps that lets you build and scale using a fully-managed PostgreSQL database powered by Cloud SQL. The REST API lets developers manage the connections to their database, change the schema of their database, and query the database.

Endpoints 29

projects.locations.services.schemas

  • GETGets details of a single Schema./v1/:nameGets details of a single Schema.
  • DELETEDeletes a single Schema/v1/:name?allowMissing=true&etag=string&force=true&requestId=string&validateOnly=trueDeletes a single Schema. Because the schema and connectors must be compatible at all times, if this is called while any connectors are active, this will…
  • PATCHUpdates the parameters of a single Schema, and creates a new SchemaRevision with the updated Schema./v1/:name?allowMissing=true&requestId=string&updateMask=string&validateOnly=trueUpdates the parameters of a single Schema, and creates a new SchemaRevision with the updated Schema.
  • GETLists Schemas in a given project and location./v1/:parent/schemas?filter=string&orderBy=string&pageSize=0&pageToken=stringLists Schemas in a given project and location.
  • POSTCreates a new Schema in a given project and location/v1/:parent/schemas?requestId=string&schemaId=string&validateOnly=trueCreates a new Schema in a given project and location. Only creation of schemas/main is supported and calling create with any other schema ID will result in an…
  • POSTExecutes SQL migration steps against the active database schema/v1/:name:migrateExecutes SQL migration steps against the active database schema. This operation compares submitted migration steps against the schema migration ledger…

projects.locations

  • GETLists information about the supported locations for this service/v1/:name/locations?extraLocationTypes=string&filter=string&pageSize=0&pageToken=stringLists information about the supported locations for this service. This method lists locations based on the resource scope provided in the…

projects.locations.operations

  • POSTStarts asynchronous cancellation on a long-running operation/v1/:name:cancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the…
  • GETLists operations that match the specified filter in the request/v1/:name/operations?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

projects.locations.services

  • GETLists Services in a given project and location./v1/:parent/services?filter=string&orderBy=string&pageSize=0&pageToken=stringLists Services in a given project and location.
  • POSTCreates a new Service in a given project and location./v1/:parent/services?requestId=string&serviceId=string&validateOnly=trueCreates a new Service in a given project and location.
  • POSTExecute any GraphQL query or mutation against the Firebase SQL Connect's generated GraphQL schema/v1/:name:executeGraphqlExecute any GraphQL query or mutation against the Firebase SQL Connect's generated GraphQL schema. Grants full read and write access to the connected data…
  • POSTExecute any GraphQL query against the Firebase SQL Connect's generated GraphQL schema/v1/:name:executeGraphqlReadExecute any GraphQL query against the Firebase SQL Connect's generated GraphQL schema. Grants full read to the connected data sources. ExecuteGraphqlRead is…
  • POSTGenerates a GraphQL query based on a natural language prompt and the provided schema context/v1/:name:generateQueryGenerates a GraphQL query based on a natural language prompt and the provided schema context. This is a stateless method; the schema is provided per request…
  • POSTGenerates GraphQL schema based on a natural language prompt or data description/v1/:name:generateSchemaGenerates GraphQL schema based on a natural language prompt or data description. This allows users to scaffold new types and tables quickly. Streams results…
  • POSTExecute introspection query against the Firebase SQL Connect's generated GraphQL schema/v1/:name:introspectGraphqlExecute introspection query against the Firebase SQL Connect's generated GraphQL schema. GraphQL introspection query provides metadata such as what tables the…

projects.locations.services.connectors

  • GETLists Connectors in a given project and location./v1/:parent/connectors?filter=string&orderBy=string&pageSize=0&pageToken=stringLists Connectors in a given project and location.
  • POSTCreates a new Connector in a given project and location/v1/:parent/connectors?connectorId=string&requestId=string&validateOnly=trueCreates a new Connector in a given project and location. The operations are validated against and must be compatible with the active schema. If the operations…
  • POSTExecute a predefined mutation in a Connector./v1/:name:executeMutationExecute a predefined mutation in a Connector.
  • POSTExecute a predefined query in a Connector./v1/:name:executeQueryExecute a predefined query in a Connector.
  • POSTImpersonate a mutation defined on a Firebase SQL Connect connector/v1/:name:impersonateMutationImpersonate a mutation defined on a Firebase SQL Connect connector. It grants the admin SDK access to mutations defined in the given connector. The caller can…
  • POSTImpersonate a query defined on a Firebase SQL Connect connector/v1/:name:impersonateQueryImpersonate a query defined on a Firebase SQL Connect connector. It grants the admin SDK access to queries defined in the given connector. The caller can…

projects.locations.services.postgrest

  • GETExecutes a dynamic SELECT (read) query on a target PostgreSQL table/v1/:firebasedataconnectService/postgrest/:firebasedataconnectTableExecutes a dynamic SELECT (read) query on a target PostgreSQL table. Projections, filters, sorting, and embeddings are mapped from the HTTP URL query…
  • PUTExecutes a dynamic UPSERT (replace or create) mutation on a target table identified by primary key filters./v1/:firebasedataconnectService/postgrest/:firebasedataconnectTableExecutes a dynamic UPSERT (replace or create) mutation on a target table identified by primary key filters.
  • POSTExecutes a dynamic INSERT (create) or UPSERT mutation on a target table./v1/:firebasedataconnectService/postgrest/:firebasedataconnectTableExecutes a dynamic INSERT (create) or UPSERT mutation on a target table.
  • DELETEExecutes a dynamic DELETE mutation on rows matching the URL filters./v1/:firebasedataconnectService/postgrest/:firebasedataconnectTableExecutes a dynamic DELETE mutation on rows matching the URL filters.
  • PATCHExecutes a dynamic UPDATE (modify) mutation on rows matching the URL filters./v1/:firebasedataconnectService/postgrest/:firebasedataconnectTableExecutes a dynamic UPDATE (modify) mutation on rows matching the URL filters.

projects.locations.services.postgrest.rpc

  • GETExecutes a read-only PostgreSQL database function./v1/:firebasedataconnectService/postgrest/rpc/:firebasedataconnectFunctionExecutes a read-only PostgreSQL database function.
  • POSTExecutes a PostgreSQL database function./v1/:firebasedataconnectService/postgrest/rpc/:firebasedataconnectFunctionExecutes a PostgreSQL database function.

API details

Base URL
https://firebasedataconnect.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter
Operations
29 operations on 19 pathsPOST 16GET 8PATCH 2DELETE 2PUT 1
Main resources
projects.locations.services 7projects.locations.services.connectors 6projects.locations.services.schemas 6projects.locations.services.postgrest 5projects.locations.operations 2projects.locations.services.postgrest.rpc 2projects.locations 1
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the Firebase SQL Connect API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Firebase SQL Connect API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Gets details of a single Schema.” (GET /v1/:name), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Firebase SQL Connect API?

Firebase SQL Connect is a relational database service for mobile and web apps that lets you build and scale using a fully-managed PostgreSQL database powered… It is listed under Communication and has 29 endpoints.

Who publishes the Firebase SQL Connect API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Firebase SQL Connect API?

Requests go to https://firebasedataconnect.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Firebase SQL Connect API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; an API key in the key query parameter.

How many endpoints does the Firebase SQL Connect API have?

29 operations on 19 paths (16 POST, 8 GET, 2 PATCH, 2 DELETE, 1 PUT). The largest groups are projects.locations.services, projects.locations.services.connectors, projects.locations.services.schemas, projects.locations.services.postgrest.

Is forking the Firebase SQL Connect API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.