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

Из этого краткого руководства вы узнаете, как:

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

Предварительные условия

Чтобы использовать это краткое руководство, вам понадобится следующее.

• Linux, macOS или Windows
• Код Visual Studio

Подключитесь к своему проекту Firebase

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

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

3. Перейдите в раздел «По��ключение данных» консоли Firebase и следуйте инструкциям по настройке продукта.

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

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

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

Выбираем и настраиваем среду разработки

Data Connect поддерживает два варианта разработки прототипов:

• Если вы являетесь разработчиком Kotlin для Android или веб- разработчиком, вы можете использовать разработку VS Code для создания прототипов схем и операций локально при подключении к экземпляру Cloud SQL для PostgreSQL.
• Если вы веб- разработчик, вы можете использовать IDX Development для создания прототипов в рабочей области IDX, используя предварительно настро��н��ы�� ��абл��н IDX с PostgreSQL, расширение VS Code с эмулятором Data Connect и настроенный для вас код быстрого запуска. Дополнительную информацию вы найдете на сайте Project IDX .

В этом кратком руководстве рассматривается процесс разработки расширения VS Code. Продолжать:

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

3. Загрузите расширение в виде пакета VSIX из Firebase Storage .

4. В VS Code в меню «Вид» выберите «Расширения» .

5. В строке заголовка панели «Расширения» щелкните значок меню more_horiz , затем выберите «Установить из VSIX...» .

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

Настройте свой локальный проект

Установите CLI, следуя обычным инструкциям . Если у вас уже установлен npm, выполните следующую команду:

npm install -g firebase-tools

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

Чтобы настроить локальный проект, инициализируйте каталог проекта.

На левой панели VS Code щелкните значок Firebase, чтобы открыть пользовательский интерфейс расширения Firebase VS Code.

В пользовательском интерфейсе расширения Firebase:

1. Убедитесь, что вы вошли в систему.
2. Нажмите кнопку «Запустить инициализацию Firebase» .
3. Проверьте вкладку «Терминал» на нижней панели VS Code для получения подсказок.
4. Выберите Data Connect в качестве функции для использования в этом каталоге.
5. При появлении запроса укажите идентификаторы проекта, службы и базы данных проекта Data Connect, который вы создали ранее в консоли.

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

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

Пользователь

В Data Connect поля GraphQL сопоставляются со столбцами. У пользователей есть uid , name и address электронной почты. Data Connect распознает несколько примитивных типов данных: String и Date .

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

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

type User @table(key: "uid") {
   uid: String!
   name: String!
   address: String!
}

По умолчанию Firebase Data Connect добавит ключ id UUID, если он не указан. Однако в этом случае вы хотите, чтобы мой uid был первичным ключом, что вы можете сделать с помощью директивы @table(key: "uid") .

Электронная почта

Теперь, когда у вас есть пользователи, вы можете моделировать электронные письма. Здесь вы можете добавить типичные поля (или столбцы) для данных электронной почты. На этот раз мы не добавляем первичный ключ, поскольку вы можете положиться на Data Connect для управления им.

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

type Email @table {
   subject: String!
   sent: Date!
   text: String!
   from: User!
}

Обратите внимание, что поле from сопоставлено с типом User . Data Connect понимает, что это отношения между Email и User , и будет управлять этими отношениями за вас.

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

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

1. Для развертывания вы можете использовать расширение Firebase VS Code.
   • В пользовательском интерфейсе расширения под панелью Firebase Data Connect нажмите « Развернуть» .
2. Возможно, вам придется просмотреть изменения схемы и одобрить потенциально разрушительные изменения. Вам будет предложено:
   • Просмотрите изменения схемы с помощью firebase dataconnect:sql:diff
   • Когда вы будете удовлетворены изменениями, примените их, используя поток, запущенный firebase dataconnect:sql:migrate .

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

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

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

1. В schema.gql нажмите кнопку «Добавить данные» над объявлением типа User .
   
2. В созданном файле User_insert.gql содержатся данные жесткого кода для трех полей.
3. Нажмите кнопку «Запустить (Производство)» .
   
4. Повторите предыдущие шаги, чтобы добавить запись в таблицу Email , указав uid вашего пользователя в поле fromUid , как было предложено в сгенерированной мутации Email_insert .

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

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

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

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

query ListEmails @auth(level: NO_ACCESS) {
  emails {
    id, subject, text, sent
    from {
      name
    }
  }
}

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

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

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

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

Если вы используете расширение Firebase VS Code для развертывания, нажмите кнопку «Развернуть все» .

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

(Необязательно) Установите PostgreSQL локально.

Локальная установка PostgreSQL и интеграция его с эмулятором позволяет создавать прототипы в полностью локальной среде разработки.

Вы можете установить новый экземпляр PostgreSQL или использовать существующий экземпляр.

Установить PostgreSQL

Установите PostgreSQL версии 15.x, следуя инструкциям для вашей платформы.

• macOS . Загрузите и установите Postgres.app .
• Windows: используйте установщик EDB со страницы загрузок PostgreSQL .
• Docker: извлеките и запустите образ pgvector/pgvector:15 , который поставляется как с PostgreSQL 15.x, так и с поддержкой векторов.
• Linux: мы рекомендуем использовать Docker с предыдущим образом, но вы также можете следовать альтернативным инструкциям для популярных дистрибутивов .

Обратите внимание на имя хоста, порт, имя пользователя и пароль, а также соответствующие параметры, выводимые во время установки.

Чтобы подключиться к вашему экземпляру PostgreSQL, эмулятору необходимо:

• Эти параметры конфигурации установки
• Имя базы данных из вашего dataconnect.yaml и базы данных с соответствующим именем, инициализированной в вашем локальном экземпляре.

Используйте свой локальный экземпляр PostgreSQL

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

firebase setup:emulators:dataconnect

При появлении запроса введите строку подключения PostgreSQL в следующем формате: postgresql://postgresusername:postgrespassword@localhost:5432/postgresdatabase?sslmode=disable .

Подробнее о строке подключения см. в документации PostgreSQL .

Подключитесь к локальному экземпляру PostgreSQL.

После завершения этой настройки для подключения к вашей локальной базе данных:

1. В VS Code на левой панели щелкните значок Firebase, чтобы открыть пользовательский интерфейс расширения Firebase VS Code.
2. Нажмите кнопку «Подключиться к локальному PostgreSQL» .

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