Data Connect şemaları tasarlama

Firebase Data Connect ile, uygulamanız için gereken veri modelini temsil eden bir GraphQL şeması tasarlarsınız. Data Connect, bu şemayı uygulamanızı destekleyen PostgreSQL için Cloud SQL örneğine dönüştürür. Ardından, arka uçla arayüz oluşturmak için sorgular ve mutasyonlar yazarsınız ve bu işlemleri, verilerinizi istemci kodundan kullanmak için bağlayıcılarda paketlersiniz.

Data Connect, şemalarınızı tasarlamanıza ve uygulamanıza yardımcı olacak yapay zeka araçları sunar. Bu kılavuzda, uygulama geliştirmeye başladığınızda standart ve yapay zeka destekli iş akışlarınızı desteklemek ve tamamlamak için şema tasarımının önemli kavramları tanıtılmaktadır. Bu kavramlar, geliştirme sürecinin ötesinde de faydalıdır.

Başlangıç kılavuzunda PostgreSQL için bir film inceleme uygulaması şeması tanıtıldı.

Bu kılavuz, söz konusu şemayı daha da geliştirir ve nihai film inceleme uygulaması şemasına eşdeğer bir SQL listelemesi sağlar.

Film inceleme uygulaması şeması

Kullanıcıların film yorumları göndermesine ve görüntülemesine olanak tanıyan bir hizmet oluşturmak istediğinizi düşünün.

Bu tür bir uygulamanın temel sorguları desteklemesi için başlangıç şemasına ihtiyacı vardır. Daha sonra karmaşık ilişkisel sorgular oluşturmak için bu şemayı genişleteceksiniz.

Data Connect bölümünde, istemcilerinizin sorgulayabileceği ve üzerinde işlem yapabileceği verilerin şeklini tanımlamak için GraphQL türlerini tanımlarsınız. Şemanızı yazdığınızda türleriniz, Cloud SQL for PostgreSQL tablolarına çevrilir. Bu işlem, GraphQL türleri ve veritabanı tabloları arasında doğrudan bir ilişkiyle yapılır ancak başka eşlemeler de mümkündür. Bu kılavuzda, temelden daha ileri seviyeye kadar bazı örnekler gösterilmektedir.

Temel bir Movie türü tanımlama

Movie türüyle başlayabilirsiniz.

Movie şeması aşağıdaki gibi temel yönergeleri içerir:

  • @table(name) ve @col(name) simgelerini kullanarak SQL tablosunu ve sütun adlarını özelleştirin. Belirtilmediği takdirde Data Connect, snake_case adları oluşturur.
  • @col(dataType) tuşlarına basarak SQL sütun türlerini özelleştirin.
  • Ekleme sırasında SQL sütunu varsayılan değerlerini yapılandırmak için @default.

Daha fazla bilgi için @table, @col, @default ile ilgili referans belgelerine göz atın.

# Movies
type Movie @table(name: "movie", key: "id") {
  id: UUID! @col(name: "movie_id") @default(expr: "uuidV4()")
  title: String!
  releaseYear: Int
  genre: String @col(dataType: "varchar(20)")
  rating: Int
  description: String
}

Önemli kullanıcı verilerini otomatik olarak User türünde depolama

Uygulamanız kullanıcıları takip edeceğinden User türüne ihtiyacınız vardır.

Bu durumda @default yönergesi özellikle yararlıdır. Buradaki id alanı, kimlik doğrulama sırasında kullanıcının kimliğini otomatik olarak alabilir. Aşağıdaki örnekte @default(expr: "auth.uid") kullanımına dikkat edin.

# Users
# Suppose a user can leave reviews for movies
type User @table {
  id: String! @default(expr: "auth.uid")
  username: String! @col(dataType: "varchar(50)")
}

Temel ölçekler ve sunucu değerleri

Film yorumu uygulamasına daha yakından bakmadan önce Data Connect temel ölçeklendirme faktörlerini ve sunucu değerlerini tanıtmak önemlidir.

Anahtar skalerler, şemalarınızdaki anahtar alanlardan Data Connect otomatik olarak oluşturulan kısa nesne tanımlayıcılarıdır. Temel ölçekler, verilerinizin kimliği ve yapısı hakkındaki bilgileri tek bir çağrıda bulmanıza olanak tanıyarak verimlilikle ilgilidir. Yeni kayıtlarda sıralı işlemler yapmak istediğinizde ve yaklaşan işlemlere aktarmak için benzersiz bir tanımlayıcıya ihtiyacınız olduğunda, ayrıca daha karmaşık ek işlemler yapmak için ilişkisel anahtarlara erişmek istediğinizde özellikle yararlıdır.

Sunucu değerlerini kullanarak, sunucunun expr bağımsız değişkenindeki belirli sunucu tarafı CEL ifadelerine göre tablolarınızdaki alanları depolanmış veya kolayca hesaplanabilir değerlerle dinamik olarak doldurmasına etkili bir şekilde izin verebilirsiniz. Örneğin, bir işlem isteğinde depolanan zaman kullanılarak alana erişildiğinde zaman damgası uygulanan bir alan tanımlayabilirsiniz updatedAt: Timestamp! @default(expr: "request.time").

Actor ve MovieActor türlerinde çoka çok ilişkileri işleme

Kullanıcıları hallettiğinize göre film verilerini modellemeye geri dönebilirsiniz.

Ardından, filmlerinizde oyuncuların rol almasını istersiniz.

Actor tablosu oldukça basittir.

# 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 {
  id: UUID! @default(expr: "uuidV4()")
  name: String! @col(dataType: "varchar(30)")
}

Oyuncuların birden fazla filmde, filmlerin de birden fazla oyuncuyla yer almasını istiyorsanız "birleştirme tablosu" kullanmanız gerekir.

MovieActor tablosu, çoktan çoka ilişkiyi işler ve birincil anahtarı [movie, actor]'ün (movie ve actor'dan gelen yabancı anahtar alanları) birleşimidir.

# Join table for many-to-many relationship for movies and actors
# The 'key' param signifies the primary keys of this table
# In this case, the keys are [movieId, actorId], the foreign key fields of the reference fields [movie, actor]
type MovieActor @table(key: ["movie", "actor"]) {
  movie: Movie!
  # movieId: UUID! <- implicitly added foreign key field
  actor: Actor!
  # actorId: UUID! <- implicitly added foreign key field
  role: String! # "main" or "supporting"
  # optional other fields
}

Yabancı anahtar kısıtlaması olan tabloda bir SQL ilişkisi tanımladığınızda, Data Connect otomatik olarak diğer tarafta ilgili alanı oluşturur. Ters eşleme alanını (ör. Actor'dan MovieActor'ye) tanımlamanız gerekmez.

Bire bir ilişkileri MovieMetadata türünde işleme

Artık film yönetmenlerini takip edebilir ve Movie ile bire bir ilişki kurabilirsiniz.

Yabancı anahtar kısıtlamalarını özelleştirmek için @ref yönergesini kullanabilirsiniz:

  • @ref(fields), hangi yabancı anahtar alanlarının kullanılacağını belirtir.
  • @ref(references), hedef tabloda referans verilen alanları belirtir (varsayılan olarak birincil anahtar kullanılır ancak @unique alanları da çalışır). Bu daha gelişmiş bir seçenektir. Data Connect genellikle bunu sizin için çıkarabilir.

Daha fazla bilgi için @ref ile ilgili referans belgelerine göz atın.

# Movie Metadata
# Movie - MovieMetadata is a one-to-one relationship
type MovieMetadata @table {
  # @unique ensures that each Movie only has one MovieMetadata.
  movie: Movie! @unique
  # Since it references to another table type, it adds a foreign key constraint.
  #  movie: Movie! @unique @ref(fields: "movieId", references: "id")
  #  movieId: UUID! <- implicitly added foreign key field
  director: String
}

İşlemler oluşturmak için şemanızdan oluşturulan alanları kullanma

Data Connect işlemleriniz, şemanızdaki türlere ve tür ilişkilerine göre otomatik olarak oluşturulan Data Connect bir dizi alanı genişletir. Bu alanlar, şemanızı her düzenlediğinizde yerel araçlar tarafından oluşturulur.

Şemanızın bir Movie türü ve ilişkili bir Actor türü içerdiğini varsayalım. Data Connect, movie, movies, actors_on_movies alanlarını ve daha fazlasını oluşturur.


movie alanı içeren sorgu

movie alanı, Movie tablosundaki tek bir kaydı temsil eder.

Bu alanı, tek bir filmi anahtarına göre sorgulamak için kullanın.

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


movies alanı içeren sorgu

movies alanı, Movie tablosundaki kayıtların listesini temsil eder.

Bu alanı, birden fazla filmi (ör. belirli bir yılda yayınlanan tüm filmler) sorgulamak için kullanın.

query GetMovies($myYear: Int!) {
  movies(where: { year: { eq: $myYear } }) { title }
}


actors_on_movies alanı içeren sorgu

actors_on_movies alanı, Actor ve Movie tablolarını bağlayan kayıtların listesini gösterir. Belirli bir filmle ilişkili tüm aktörleri sorgulamak için bu alanı kullanın.

Belirli bir filmle ilişkili tüm aktörleri sorgulamak için bu alanı kullanın.

  query GetActorsOnMovie($myKey: Movie_Key!) {
    actors_on_movies(where: { movie: { key: { eq: $myKey } } }) {
      actor { name }
    }
  }

Bu bilgileri göz önünde bulundurarak, sorgu uygulama kılavuzu ve değişiklik uygulama kılavuzunda bu alanları kullanarak işlemleri nasıl uygulayacağınızı öğrenebilirsiniz.

Daha ileri düzey şema kavramları

Temel ancak faydalı türlerin ve ilişkilerin ötesine geçmek için referans dokümanlarındaki örneklere bakın.

Desteklenen veri türleri

Data Connect, @col(dataType:) kullanılarak PostgreSQL türlerine atamalarla birlikte aşağıdaki skaler veri türlerini destekler.

Data Connect tür Yerleşik GraphQL türü veya
Data Connect özel tür 		Varsayılan PostgreSQL türü Desteklenen PostgreSQL türleri
(parantez içindeki diğer ad)
Dize GraphQL metin text
bit(n), varbit(n)
char(n), varchar(n)
Int GraphQL int Int2 (smallint, smallserial),
int4 (integer, int, serial)
Kayan GraphQL float8 float4 (real)
float8 (double precision)
numeric (decimal)
Boole GraphQL boolean boolean
UUID Özel uuid uuid
Int64 Özel bigint int8 (bigint, bigserial)
numeric (decimal)
Tarih Özel date tarih
Zaman damgası Özel timestamptz

timestamptz

Not: Yerel saat dilimi bilgileri depolanmaz.
PostgreSQL, bu tür zaman damgalarını UTC olarak dönüştürür ve depolar.
Vector Özel vector

vektör

Vertex AI ile vektör benzerliği araması yapma başlıklı makaleyi inceleyin.
  • GraphQL List tek boyutlu bir diziyle eşlenir.
    • Örneğin, [Int], int5[] ile, [Any] ise jsonb[] ile eşleşir.
    • Data Connect iç içe dizileri desteklemez.

Eşdeğer SQL şeması

-- 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);

Sonraki adımlar

İlginizi çekebilir: