Начало работы с Firebase Data Connect

Примечание. Firebase Data Connect находится в общедоступной предварительной версии. На Data Connect распространяются «Условия предложений Pre-GA» в разделе «Особые условия обслуживания» Условий использования Google Cloud Platform. Функции Pre-GA доступны «как есть» и могут иметь ограниченную поддержку. Дополнительную информацию см. в описании этапов запуска .

Примечание. Следуйте этому краткому руководству, если вы хотите добавить Data Connect в один из ваших проектов Firebase в плане Blaze , создать службу Data Connect и подготовить базу данных Cloud SQL для прототипирования. Если вы предпочитаете использовать план Spark и создавать прототипы локально с помощью эмулятора и локальной базы данных, попробуйте начать локальную разработку .

В этом кратком руководстве вы узнаете, как создать Firebase Data Connect в своем приложении с помощью производственного экземпляра SQL. Вы будете:

• Добавьте Firebase Data Connect в свой проект Firebase.
• Предоставьте экземпляр Cloud SQL для своего приложения.
• Настройте среду разработки, включая расширение Visual Studio Code, для работы с производственным экземпляром.
• Тогда мы покажем вам, как:
  • Создание схемы для приложения для просмотра фильмов
  • Определите запросы и мутации , которые будут использоваться в вашем приложении.
  • Протестируйте свои запросы и мутации с помощью образцов данных.
  • Создавайте строго типизированные SDK и используйте их в своем приложении.
  • Разверните окончательную схему, запросы и данные в облаке.

Найдите репозиторий приложений для быстрого запуска и создайте полнофункциональное приложение Data Connect , следуя нашей лаборатории кода для Интернета . Скоро появятся Codelabs для Android и iOS.

Создайте проект Firebase и базу данных Cloud SQL.

1. Если вы еще этого не сделали, создайте проект Firebase.
   1. В консоли Firebase нажмите «Добавить проект » и следуйте инструкциям на экране.
2. Перейдите в раздел Data Connect консоли Firebase и следуйте инструкциям по настройке продукта.

3. Обновите свой проект до плана Blaze. Это позволит вам создать экземпляр Cloud SQL для PostgreSQL.

   Примечание. Несмотря на то, что вы настроили выставление счетов при обновлении Blaze, с вас не будет взиматься плата за использование Data Connect или конфигурации Cloud SQL для PostgreSQL по умолчанию во время предварительной версии.

4. Выберите расположение базы данных CloudSQL для PostgreSQL.

5. Запишите имена и идентификаторы проекта, службы и базы данных для подтверждения позже.

6. Следуйте оставшейся процедуре настройки и нажмите «Готово» .

   Примечание. Подготовка экземпляра Cloud SQL для PostgreSQL может занять до 15 минут. Вы можете подтвердить, что процесс настройки Data Connect , включая предоставление базы данных, завершен, с помощью консоли Google Cloud .

Выберите поток разработки

Data Connect предлагает два способа установки инструментов разработки.

Автоматическая установка (macOS или Linux) Ручная установка (Windows)

Настройка среды разработки

1. Создайте новый каталог для вашего локального проекта.

2. Запустите следующую команду в новом созданном каталоге.

     curl -sL https://firebase.tools/dataconnect | bash

   Этот сценарий пытается настроить для вас среду разработки и запустить IDE на основе браузера. Эта IDE предоставляет инструменты, в том числе предварительно связанное расширение VS Code, которые помогут вам управлять схемой, определять запросы и мутации, которые будут использоваться в вашем приложении, а также генерировать строго типизированные SDK.

   Примечание. Если у вас уже установлена ​​настольная версия VS Code, скрипт откроет ее автоматически.
   Примечание. В случае сбоя сценария выполните действия по установке вручную .

Совет: При желании вы можете настроить псевдоним, добавив следующую строку в свой профиль оболочки (например, ~/.zshrc или ~/.bash_profile ). Это позволяет вам локально обновить инструменты или перезапустить интегрированную среду разработки на основе браузера, просто набрав dataconnect .

alias dataconnect='curl -sL https://firebase.tools/dataconnect | bash'

Настройте каталог вашего проекта

Чтобы настроить локальный проект, инициализируйте каталог проекта. В окне IDE на левой панели щелкните значок Firebase, чтобы открыть пользовательский интерфейс расширения Data Connect VS Code:

1. Нажмите кнопку «Войти через Google» .
2. Нажмите кнопку «Подключить проект Firebase» и выберите в консоли проект, который вы создали ранее.
3. Нажмите кнопку «Запустить инициализацию Firebase» и завершите процесс.

4. Нажмите кнопку «Запустить эмуляторы» .

   Примечание. Во встроенном терминале убедитесь, что настроенные вами эмуляторы запускаются. Как только они запустятся, вы должны увидеть обновление пользовательского интерфейса расширения с подробной информацией об эмуляторе.

Создать схему

В каталоге проекта Firebase в файле /dataconnect/schema/schema.gql начните определять схему GraphQL, включающую фильмы.

Фильм

В Data Connect поля GraphQL сопоставляются со столбцами. Тип Movie имеет id , title , imageUrl и genre . Data Connect распознает примитивные типы данных String и UUID .

Скопируйте следующий фрагмент или раскомментируйте соответствующие строки в файле.

# File `/dataconnect/schema/schema.gql`

# By default, a UUID id key will be created by default as primary key.
type Movie @table {
  id: UUID! @default(expr: "uuidV4()")
  title: String!
  imageUrl: String!
  genre: String
}

ФильмМетаданные

Теперь, когда у вас есть фильмы, вы можете моделировать метаданные фильма.

Скопируйте следующий фрагмент или раскомментируйте соответствующие строки в файле.

# Movie - MovieMetadata is a one-to-one relationship
type MovieMetadata @table {
  # This time, we omit adding a primary key because
  # you can rely on Data Connect to manage it.

  # @unique indicates a 1-1 relationship
  movie: Movie! @unique
  # movieId: UUID <- this is created by the above reference
  rating: Float
  releaseYear: Int
  description: String
}

Обратите внимание, что поле movie сопоставлено с типом Movie . Data Connect понимает, что это связь между Movie и MovieMetadata , и будет управлять этой связью за вас.

Дополнительные сведения о схемах Data Connect см. в документации.

Разверните свою схему в рабочей среде

Прежде чем продолжить, вам необходимо развернуть схему.

Примечание. Подготовка экземпляра Cloud SQL для PostgreSQL может занять до 15 минут. Вы не сможете выполнить развертывание, пока ваш экземпляр не будет готов. Прежде чем развернуть схему, подтвердите, что процесс настройки Data Connect , включая подготовку базы данных, завершен с помощью консоли Google Cloud .

В пользовательском интерфейсе расширения на панели Firebase Data Connect нажмите «Развернуть в производство» .

После развертывания схемы в рабочей базе данных вы сможете просмотреть ее в консоли Firebase .

Добавьте данные в свои таблицы

На панели редактора IDE вы можете увидеть, как кнопки CodeLens появляются над типами GraphQL в /dataconnect/schema/schema.gql . Поскольку вы развернули свою схему в рабочей среде, вы можете использовать кнопки «Добавить данные» и «Запустить (производственная)», чтобы добавить данные в свою базу данных на серверной стороне.

Чтобы добавить записи в таблицу Movie :

1. В schema.gql нажмите кнопку «Добавить данные» над объявлением типа Movie .
   
2. В создаваемом файле Movie_insert.gql данные жесткого кода для четырех полей.
3. Нажмите кнопку «Запустить (Производство)» .
   
4. Повторите предыдущие шаги, чтобы добавить запись в таблицу MovieMetadata , указав id вашего фильма в поле movieId , как это было предложено в сгенерированной мутации MovieMetadata_insert .

Для быстрой проверки данных добавлено:

1. Вернувшись в schema.gql , нажмите кнопку «Читать данные» над объявлением типа Movie .
2. В полученном файле Movie_read.gql нажмите кнопку «Выполнить» (производство), чтобы выполнить запрос.

Узнайте больше о мутациях Data Connect в документации.

Определите свой запрос

Теперь самое интересное, запросы. Как разработчик, вы привыкли писать запросы SQL, а не запросы GraphQL, поэтому поначалу это может показаться немного другим. Однако GraphQL гораздо более краток и типобезопасен, чем чистый SQL. А наше расширение VS Code упрощает разработку.

Начните редактировать файл /dataconnect/connector/queries.gql . Если вы хотите получить все фильмы, используйте такой запрос.

# File `/dataconnect/connector/queries.gql`

# @auth() directives control who can call each operation.
# Anyone should be able to list all movies, so the auth level
# is set to PUBLIC
query ListMovies @auth(level: PUBLIC) {
  movies {
    id
    title
    imageUrl
    genre
  }
}

Выполните запрос, используя расположенную рядом кнопку CodeLens.

Совет. Вы можете использовать Gemini в Firebase , чтобы создавать и тестировать запросы GraphQL в консоли Firebase . Узнайте больше в разделе «Использование помощи искусственного интеллекта для запросов и мутаций» .

Дополнительные сведения о запросах Data Connect см. в документации.

Создавайте SDK и используйте их в своем приложении.

1. Нажмите кнопку «Добавить SDK в приложение» .

2. В появившемся диалоговом окне выберите каталог, содержащий код вашего приложения. Код Data Connect SDK будет создан и сохранен там.

   Примечание. Если у вас еще нет каталога приложения, вы можете создать и выбрать новый каталог для кода SDK, а затем связать его со своим приложением позже.

3. Выберите платформу своего приложения и обратите внимание, что код SDK сразу же создается в выбранном вами каталоге.

Узнайте, как использовать сгенерированный SDK для вызова запросов и мутаций из клиентских приложений ( веб , Android , iOS , Flutter ).

Разверните свою схему и запросите ее в рабочей среде

Вы прошли итерацию разработки. Теперь вы можете развернуть свою схему, данные и запросы на сервере с помощью пользовательского интерфейса расширения Firebase или интерфейса командной строки Firebase , так же, как вы это делали со своей схемой.

В окне IDE в пользовательском интерфейсе расширения кода VS нажмите кнопку «Развернуть в производство» .

После развертывания перейдите в консоль Firebase чтобы убедиться, что схема, операции и данные загружены в облако. У вас должна быть возможность просматривать схему и выполнять операции на консоли. Экземпляр Cloud SQL для PostgreSQL будет обновлен с учетом окончательной развернутой сгенерированной схемы и данных.

Подробную информацию об использовании эмулятора Data Connect можно найти в документации.

Следующие шаги

Просмотрите развернутый проект и откройте для себя дополнительные инструменты:

• Добавляйте данные в свою базу данных, проверяйте и изменяйте свои схемы, а также отслеживайте работу службы Data Connect в консоли Firebase . Дополнительную информацию можно найти в документации. Например, после завершения краткого руководства:

• Узнайте больше о разработке схем, запросов и мутаций.

• Узнайте о создании клиентских SDK, вызове запросов и мутациях из клиентского кода для Интернета , Android , iOS и Flutter .