Esquemas, consultas e mutações do Data Connect

O Firebase Data Connect permite criar conectores para o PostgreSQL de instâncias gerenciadas com o Google Cloud SQL. Esses conectores são combinações de um esquema, consultas e mutações para usar seus dados.

O Guia explicativo apresentou uma resenha de filme de aplicativo para PostgreSQL. Este guia explica em detalhes como projetar Data Connect esquemas para PostgreSQL.

Este guia combina consultas e mutações Data Connect com exemplos de esquemas. Por que discutir consultas (e mutações) em um guia sobre Data Connect esquemas? Assim como outras plataformas baseadas em GraphQL, Firebase Data Connect é uma plataforma de desenvolvimento que prioriza consultas. Portanto, desenvolvedor. Na modelagem de dados, você pensará nos dados que seus clientes necessidade, o que influenciará muito o esquema de dados que você desenvolver para o projeto.

Este guia começa com um novo esquema para resenhas de filmes, depois aborda as consultas e mutações derivadas desse esquema e, por fim, fornece uma lista de SQL equivalente ao esquema principal Data Connect.

O esquema para um app de crítica de filmes

Imagine que você quer criar um serviço que permita que os usuários enviem e assistam filmes avaliações.

Você precisa de um esquema inicial para esse app. Este esquema será estendido mais tarde para criar consultas relacionais complexas.

Tabela de filmes

O esquema para filmes contém diretivas principais, como:

  • @table, que nos permite definir nomes de operação usando singular. e plural argumentos
  • @col para definir explicitamente os nomes das colunas
  • @default para permitir que os padrões sejam definidos.
# Movies
type Movie
  @table(name: "Movies", singular: "movie", plural: "movies", key: ["id"]) {
  id: UUID! @col(name: "movie_id") @default(expr: "uuidV4()")
  title: String!
  releaseYear: Int @col(name: "release_year")
  genre: String
  rating: Int @col(name: "rating")
  description: String @col(name: "description")
}

Valores de servidor e chaves escalares

Antes de analisar o app de crítica de filmes, vamos apresentar Data Connect valores do servidor e escalares de chaves.

Usando valores do servidor, é possível permitir que o servidor preencha campos de forma dinâmica nas tabelas usando valores armazenados ou facilmente calculáveis de acordo com expressões específicas do lado do servidor. Por exemplo, é possível definir um campo com um carimbo de data/hora aplicado quando o campo é acessado usando a expressão updatedAt: Timestamp! @default(expr: "request.time").

Os escalares de chave são identificadores de objetos concisos que o Data Connect automaticamente usa campos-chave nos esquemas. Os principais escalares referem-se à eficiência, permitindo que você encontre em uma única chamada informações sobre a identidade e estrutura dos seus dados. Eles são especialmente úteis quando se quer realizar ações sequenciais em novos registros e precisam de um identificador exclusivo para próximas operações, e também quando quiser acessar chaves relacionais para e executar outras operações mais complexas.

Tabela de metadados do filme

Agora, vamos acompanhar os diretores de filmes e configurar uma reunião relação com Movie.

Adicione a diretiva @ref para definir relações.

# Movie Metadata
# Movie - MovieMetadata is a one-to-one relationship
type MovieMetadata
  @table(
    name: "MovieMetadata"
  ) {
  # @ref creates a field in the current table (MovieMetadata) that holds the
  # primary key of the referenced type
  # In this case, @ref(fields: "id") is implied
  movie: Movie! @ref
  # movieId: UUID <- this is created by the above @ref
  director: String @col(name: "director")
}

Ator

Em seguida, você quer que atores estrelem seus filmes. Como você tem uma relação muitos-para-muitos entre filmes e atores, crie uma tabela de mesclagem.

# Actors
# Suppose an actor can participate in multiple movies and movies can have multiple actors
# Movie - Actors (or vice versa) is a many to many relationship
type Actor @table(name: "Actors", singular: "actor", plural: "actors") {
  id: UUID! @col(name: "actor_id") @default(expr: "uuidV4()")
  name: String! @col(name: "name", dataType: "varchar(30)")
}
# Join table for many-to-many relationship for movies and actors
# The 'key' param signifies the primary key(s) of this table
# In this case, the keys are [movieId, actorId], the generated fields of the reference types [movie, actor]

type MovieActor @table(key: ["movie", "actor"]) {
  # @ref creates a field in the current table (MovieActor) that holds the primary key of the referenced type
  # In this case, @ref(fields: "id") is implied
  movie: Movie! @ref
  # movieId: UUID! <- this is created by the above @ref, see: implicit.gql
  actor: Actor! @ref
  # actorId: UUID! <- this is created by the above @ref, see: implicit.gql
  role: String! @col(name: "role") # "main" or "supporting"
  # optional other fields
}

Usuário

Por fim, os usuários do seu app.

# Users
# Suppose a user can leave reviews for movies
# user:reviews is a one to many relationship, movie:reviews is a one to many relationship, movie:user is a many to many relationship
type User
  @table(name: "Users", singular: "user", plural: "users", key: ["id"]) {
  id: UUID! @col(name: "user_id") @default(expr: "uuidV4()")
  auth: String @col(name: "user_auth") @default(expr: "auth.uid")
  username: String! @col(name: "username", dataType: "varchar(30)")
  # The following are generated from the @ref in the Review table
  # reviews_on_user
  # movies_via_Review
}

Tipos de dados com suporte

Data Connect oferece suporte aos seguintes tipos de dados escalares, com atribuições para tipos do PostgreSQL usando @col(dataType:).

Tipo Data Connect Tipo integrado do GraphQL ou
Data Connect personalizado 		Tipo padrão do PostgreSQL Tipos do PostgreSQL com suporte
(alias entre parênteses)
String GraphQL texto texto
bit(n), varbit(n)
char(n), varchar(n)
Int GraphQL int Int2 (smallint, smallserial),
int4 (integer, int, serial)
Ponto flutuante GraphQL float8 float4 (real)
float8 (precisão dupla)
numérico (decimal)
Booleano GraphQL booleano booleano
UUID Personalizado uuid (em inglês) uuid
Int64 Personalizado bigint int8 (bigint, bigserial)
numeric (decimal)
Data Personalizado date data
Carimbo de data/hora Personalizado timestamptz (em inglês)

Carimbo de data/hora

Observação: as informações de fuso horário local não são armazenadas.
O PostgreSQL converte e armazena esses carimbos de data/hora como UTC.
Vetor Personalizado vetor

vetor

Consulte Realizar pesquisa de semelhança vetorial com a Vertex AI.
  • O List do GraphQL é mapeado para uma matriz unidimensional.
    • Por exemplo, [Int] é mapeado para int5[], e [Any] é mapeado para jsonb[].
    • Data Connect não aceita matrizes aninhadas.

Consultas e mutações implícitas e predefinidas

As consultas e mutações Data Connect vão estender um conjunto de consultas implícitas e mutações implícitas geradas por Data Connect com base nos tipos e nas relações de tipo no seu esquema. As consultas e mutações implícitas são geradas pelas ferramentas locais sempre que você edita o esquema.

No processo de desenvolvimento, você vai implementar consultas predefinidas e mutações predefinidas com base nessas operações implícitas.

Nomeação de mutação e consulta implícita

Data Connect infere nomes adequados para consultas implícitas e mutações nas declarações de tipo de esquema. Por exemplo, trabalhar com um PostgreSQL fonte, se você definir uma tabela chamada Movie, o servidor vai gerar um valor implícito:

  • Consultas para casos de uso de tabela única com os nomes amigáveis movie (singular, para recuperar resultados individuais transmitindo argumentos como eq) e movies (plural, para recuperar listas de resultados transmitindo argumentos como gt e operações como orderby). Data Connect também gera consultas para operações relacionais de várias tabelas com nomes explícitos, como actors_on_movies ou actors_via_actormovie.
  • Mutações com os nomes movie_insert, movie_upsert...

A linguagem de definição de esquema também permite que você defina nomes explicitamente para operações usando argumentos de diretiva singular e plural.

Consultas para o banco de dados de resenhas de filmes

Você define uma consulta Data Connect com um tipo de operação de consulta , nome da operação, zero ou mais argumentos de operação e zero ou mais diretivas com argumentos.

No guia de início rápido, a consulta de exemplo listEmails não usou parâmetros. Obviamente, em muitos casos, os dados transmitidos para os campos de consulta são dinâmicos. É possível usar a sintaxe $variableName para trabalhar com variáveis como um dos componentes de uma definição de consulta.

A consulta abaixo tem:

  • Uma definição de tipo query
  • Um nome de operação (consulta) ListMoviesByGenre
  • Um único argumento de operação de variável $genre
  • Uma única diretiva, @auth.
query ListMoviesByGenre($genre: String!) @auth(level: USER)

Cada argumento de consulta requer uma declaração de tipo, um tipo integrado como String ou um tipo personalizado definido pelo esquema, como Movie.

Vejamos a assinatura das consultas cada vez mais complexas. Você vai terminar introduzindo expressões de relacionamento poderosas e concisas disponíveis em consultas que você pode usar nas consultas predefinidas.

Principais escalares em consultas

Mas primeiro, uma observação sobre os escalares de chave.

Data Connect define um tipo especial para as chaves escalares, identificado por _Key. Por exemplo, o tipo de um escalar de chave para nossa tabela Movie é Movie_Key.

Recupere escalares de chave como uma resposta retornada pela maioria das mutações implícitas, ou das consultas em que você recuperou todos os campos necessários para criar a chave escalar.

Consultas automáticas únicas, como movie em nosso exemplo, oferecem suporte a uma chave que aceite uma chave escalar.

Você pode passar uma chave escalar como um literal. No entanto, é possível definir variáveis para transmitir escalares de chave como entrada.

query GetMovie($myKey: Movie_Key!) {
  movie(key: $myKey) { title }
}

Eles podem ser fornecidos no JSON da solicitação, como este (ou outros formatos de serialização):

{
  # …
  "variables": {
    "myKey": {"foo": "some-string-value", "bar": 42}
  }
}

Graças à análise escalar personalizada, um Movie_Key também pode ser construído usando o do objeto, que pode conter variáveis. Isso é útil principalmente quando você quer dividir componentes individuais em variáveis diferentes por algum motivo.

Alias em consultas

O Data Connect oferece suporte a pseudônimos do GraphQL em consultas. Com os pseudônimos, você renomeia os dados retornados nos resultados de uma consulta. Uma única consulta Data Connect pode aplicar vários filtros ou outras operações de consulta em uma solicitação eficiente para o servidor, emitindo várias "subconsultas" de uma só vez. Para evitar colisões de nome no conjunto de dados retornado, use aliases para distinguir as subconsultas.

Esta é uma consulta em que uma expressão usa o alias mostPopular.

query ReviewTopPopularity($genre: String) {
  mostPopular: review(first: {
    where: {genre: {eq: $genre}},
    orderBy: {popularity: DESC}
  }) { … }
}

Consultas simples com filtros

As consultas Data Connect mapeiam para todos os filtros e ordens comuns do SQL as operações.

Operadores where e orderBy (consultas singular e plural)

Retorna todas as linhas correspondentes da tabela (e as associações aninhadas). Retorna uma matriz vazia se nenhum registro corresponder ao filtro.

query MovieByTopRating($genre: String) {
  mostPopular: movies(
     where: { genre: { eq: $genre } }, orderBy: { rating: DESC }
  ) {
    # graphql: list the fields from the results to return
    id
    title
    genre
    description
  }
}

query MoviesByReleaseYear($min: Int, $max: Int) {
  movies(where: {releaseYear: {le: $max, ge: $min}}, orderBy: [{releaseYear: ASC}]) { … }
}

Operadores limit e offset (consultas no singular e no plural)

Você pode executar a paginação nos resultados. Esses argumentos são aceitos, mas não retornados nos resultados.

query MoviesTop10 {
  movies(orderBy: [{ rating: DESC }], limit: 10) {
    # graphql: list the fields from the results to return
    title
  }
}

inclui para campos de matriz

É possível testar se um campo de matriz inclui um item especificado.

# Filter using arrays and embedded fields.
query ListMoviesByTag($tag: String!) {
  movies(where: { tags: { includes: $tag }}) {
    # graphql: list the fields from the results to return
    id
    title
  }
}

Operações de string e expressões regulares

Suas consultas podem usar operações típicas de pesquisa e comparação de strings, incluindo expressões regulares. Para ser mais eficiente, você está agrupando várias operações aqui e resolvendo o conflito com aliases.

query MoviesTitleSearch($prefix: String, $suffix: String, $contained: String, $regex: String) {
  prefixed: movies(where: {title: {startsWith: $prefix}}) {...}
  suffixed: movies(where: {title: {endsWith: $suffix}}) {...}
  contained: movies(where: {title: {contains: $contained}}) {...}
  matchRegex: movies(where: {title: {pattern: {regex: $regex}}}) {...}
}

or e and para filtros compostos

Use or e and para uma lógica mais complexa.

query ListMoviesByGenreAndGenre($minRating: Int!, $genre: String) {
  movies(
    where: { _or: [{ rating: { ge: $minRating } }, { genre: { eq: $genre } }] }
  ) {
    # graphql: list the fields from the results to return
    title
  }
}

Consultas complexas

As consultas Data Connect podem acessar dados com base nas relações entre tabelas. É possível usar as relações de objeto (um para um) ou matriz (um para muitos) definidas no esquema para fazer consultas aninhadas, ou seja, buscar dados de um tipo com dados de um tipo aninhado ou relacionado.

Essas consultas usam a sintaxe _on_ e Data Connect mágicas e _via em consultas implícitas geradas.

Você vai fazer modificações no esquema da versão inicial.

Muitos para um

Vamos adicionar avaliações ao app com uma tabela Review e modificações em User.

# Users
# Suppose a user can leave reviews for movies
# user:reviews is a one to many relationship,
# movie:reviews is a one to many relationship,
# movie:user is a many to many relationship
type User
  @table(name: "Users", singular: "user", plural: "users", key: ["id"]) {
  id: UUID! @col(name: "user_id") @default(expr: "uuidV4()")
  auth: String @col(name: "user_auth") @default(expr: "auth.uid")
  username: String! @col(name: "username", dataType: "varchar(30)")
  # The following are generated from the @ref in the Review table
  # reviews_on_user
  # movies_via_Review
}
# Reviews
type Review @table(name: "Reviews", key: ["movie", "user"]) {
  id: UUID! @col(name: "review_id") @default(expr: "uuidV4()")
  user: User! @ref
  movie: Movie! @ref
  rating: Int
  reviewText: String
  reviewDate: Date! @default(expr: "request.time")
}

Consulta de muitos para um

Agora, vamos ver uma consulta, com alias, para ilustrar a sintaxe _via_.

query UserMoviePreferences($username: String!) @auth(level: USER) {
  users(where: { username: { eq: $username } }) {
    likedMovies: movies_via_review(where: { rating: { ge: 4 } }) {
      title
      genre
      description
    }
    dislikedMovies: movies_via_review(where: { rating: { le: 2 } }) {
      title
      genre
      description
    }
  }
}

Um para um

Observe o padrão. Confira abaixo o esquema modificado para fins ilustrativos.

# Movies
type Movie
  @table(name: "Movies", singular: "movie", plural: "movies", key: ["id"]) {
  id: UUID! @col(name: "movie_id") @default(expr: "uuidV4()")
  title: String!
  releaseYear: Int @col(name: "release_year")
  genre: String
  rating: Int @col(name: "rating")
  description: String @col(name: "description")
  tags: [String] @col(name: "tags")
}
# Movie Metadata
# Movie - MovieMetadata is a one-to-one relationship
type MovieMetadata
  @table(
    name: "MovieMetadata"
  ) {
  # @ref creates a field in the current table (MovieMetadata) that holds the primary key of the referenced type
  # In this case, @ref(fields: "id") is implied
  movie: Movie! @ref
  # movieId: UUID <- this is created by the above @ref
  director: String @col(name: "director")
}


extend type MovieMetadata {
  movieId: UUID! # matches primary key of referenced type
...
}

extend type Movie {
  movieMetadata: MovieMetadata # can only be non-nullable on ref side
  # conflict-free name, always generated
  movieMetadatas_on_movie: MovieMetadata
}

Consulta individual

É possível consultar usando a sintaxe _on_.

# One to one
query GetMovieMetadata($id: UUID!) @auth(level: PUBLIC) {
  movie(id: $id) {
    movieMetadatas_on_movie {
      director
    }
  }
}

Muitos para muitos

Os filmes precisam de atores, e os atores precisam de filmes. Eles têm muitos para muitos relação que você pode modelar com uma tabela de mesclagem MovieActors.

# MovieActors Join Table Definition
type MovieActors @table(
  key: ["movie", "actor"] # join key triggers many-to-many generation
) {
  movie: Movie!
  actor: Actor!
}

# generated extensions for the MovieActors join table
extend type MovieActors {
  movieId: UUID!
  actorId: UUID!
}

# Extensions for Actor and Movie to handle many-to-many relationships
extend type Movie {
  movieActors: [MovieActors!]! # standard many-to-one relation to join table
  actors: [Actor!]! # many-to-many via join table

  movieActors_on_actor: [MovieActors!]!
  # since MovieActors joins distinct types, type name alone is sufficiently precise
  actors_via_MovieActors: [Actor!]!
}

extend type Actor {
  movieActors: [MovieActors!]! # standard many-to-one relation to join table
  movies: [Movie!]! # many-to-many via join table

  movieActors_on_movie: [MovieActors!]!
  movies_via_MovieActors: [Movie!]!
}

Consultar muitos para muitos

Vamos ver uma consulta, com alias, para ilustrar a sintaxe da _via_.

query GetMovieCast($movieId: UUID!, $actorId: UUID!) @auth(level: PUBLIC) {
  movie(id: $movieId) {
    mainActors: actors_via_MovieActor(where: { role: { eq: "main" } }) {
      name
    }
    supportingActors: actors_via_MovieActor(
      where: { role: { eq: "supporting" } }
    ) {
      name
    }
  }
  actor(id: $actorId) {
    mainRoles: movies_via_MovieActor(where: { role: { eq: "main" } }) {
      title
    }
    supportingRoles: movies_via_MovieActor(
      where: { role: { eq: "supporting" } }
    ) {
      title
    }
  }
}

Mutações para o banco de dados de resenhas de filmes

Como mencionado, quando você define uma tabela no esquema, Data Connect vai gerar mutações implícitas básicas para cada tabela.

type Movie @table { ... }

extend type Mutation {
  # Insert a row into the movie table.
  movie_insert(...): Movie_Key!
  # Upsert a row into movie."
  movie_upsert(...): Movie_Key!
  # Update a row in Movie. Returns null if a row with the specified id/key does not exist
  movie_update(...): Movie_Key
  # Update rows based on a filter in Movie.
  movie_updateMany(...): Int!
  # Delete a single row in Movie. Returns null if a row with the specified id/key does not exist
  movie_delete(...): Movie_Key
  # Delete rows based on a filter in Movie.
  movie_deleteMany(...): Int!
}

Com eles, é possível implementar casos principais de CRUD cada vez mais complexos. Diga isso cinco vezes rápido!

Criar

Vamos fazer criações básicas.

# Create a movie based on user input
mutation CreateMovie($title: String!, $releaseYear: Int!, $genre: String!, $rating: Int!) {
  movie_insert(data: {
    title: $title
    releaseYear: $releaseYear
    genre: $genre
    rating: $rating
  })
}

# Create a movie with default values
mutation CreateMovie2 {
  movie_insert(data: {
    title: "Sherlock Holmes"
    releaseYear: 2009
    genre: "Mystery"
    rating: 5
  })
}

Ou fazer um upsert.

# Movie upsert using combination of variables and literals
mutation UpsertMovie($title: String!) {
  movie_upsert(data: {
    title: $title
    releaseYear: 2009
    genre: "Mystery"
    rating: 5
    genre: "Mystery/Thriller"
  })
}

Executar atualizações

Aqui estão as atualizações. Produtores e diretores certamente esperam que essas classificações médias estejam em tendência.

mutation UpdateMovie(
  $id: UUID!,
  $genre: String!,
  $rating: Int!,
  $description: String!
) {
  movie_update(id: $id, data: {
    genre: $genre
    rating: $rating
    description: $description
  })
}

# Multiple updates (increase all ratings of a genre)
mutation IncreaseRatingForGenre($genre: String!, $ratingIncrement: Int!) {
  movie_updateMany(
    where: { genre: { eq: $genre } },
    update: { rating: { inc: $ratingIncrement } }
  )
}

Executar exclusões

É possível excluir os dados do filme. Os conservadores de filmes certamente queremos que os filmes físicos sejam mantidos pelo maior tempo possível.

# Delete by key
mutation DeleteMovie($id: UUID!) {
  movie_delete(id: $id)
}

Aqui você pode usar _deleteMany.

# Multiple deletes
mutation DeleteUnpopularMovies($minRating: Int!) {
  movie_deleteMany(where: { rating: { le: $minRating } })
}

Escrever mutações em relações

Confira como usar a mutação _upsert implícita em uma relação.

# Create or update a one to one relation
mutation MovieMetadataUpsert($movieId: UUID!, $director: String!) {
  movieMetadata_upsert(
    data: { movie: { id: $movieId }, director: $director }
  )
}

Esquema SQL equivalente

-- Movies Table
CREATE TABLE Movies (
    movie_id UUID DEFAULT uuid_generate_v4() PRIMARY KEY,
    title VARCHAR(255) NOT NULL,
    release_year INT,
    genre VARCHAR(30),
    rating INT,
    description TEXT,
    tags TEXT[]
);
-- Movie Metadata Table
CREATE TABLE MovieMetadata (
    movie_id UUID REFERENCES Movies(movie_id) UNIQUE,
    director VARCHAR(255) NOT NULL,
    PRIMARY KEY (movie_id)
);
-- Actors Table
CREATE TABLE Actors (
    actor_id UUID DEFAULT uuid_generate_v4() PRIMARY KEY,
    name VARCHAR(30) NOT NULL
);
-- MovieActor Join Table for Many-to-Many Relationship
CREATE TABLE MovieActor (
    movie_id UUID REFERENCES Movies(movie_id),
    actor_id UUID REFERENCES Actors(actor_id),
    role VARCHAR(50) NOT NULL, # "main" or "supporting"
    PRIMARY KEY (movie_id, actor_id),
    FOREIGN KEY (movie_id) REFERENCES Movies(movie_id),
    FOREIGN KEY (actor_id) REFERENCES Actors(actor_id)
);
-- Users Table
CREATE TABLE Users (
    user_id UUID DEFAULT uuid_generate_v4() PRIMARY KEY,
    user_auth VARCHAR(255) NOT NULL
    username VARCHAR(30) NOT NULL
);
-- Reviews Table
CREATE TABLE Reviews (
    review_id UUID DEFAULT uuid_generate_v4() PRIMARY KEY,
    user_id UUID REFERENCES Users(user_id),
    movie_id UUID REFERENCES Movies(movie_id),
    rating INT,
    review_text TEXT,
    review_date TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
    UNIQUE (movie_id, user_id)
    FOREIGN KEY (user_id) REFERENCES Users(user_id),
    FOREIGN KEY (movie_id) REFERENCES Movies(movie_id)
);
-- Self Join Example for Movie Sequel Relationship
ALTER TABLE Movies
ADD COLUMN sequel_to UUID REFERENCES Movies(movie_id);

A seguir