Справочник по настройке и безопасности

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.

Firebase CLI позволяет вам управлять проектами Firebase в локальном каталоге проектов с контролируемой версией. Сюда входят службы Data Connect в ваших проектах, коннекторы для этих служб и ресурсы, такие как схемы, запросы и источники мутаций для каждого коннектора. CLI также позволяет вам устанавливать и использовать эмулятор Firebase Data Connect . CLI — это эффективная альтернатива работе в консоли Firebase .

Инструкции по установке эксперимента Firebase CLI для программы Private Preview и команды CLI, связанные с Data Connect , см. в справочнике CLI .

В этом справочном руководстве представлены:

• Записи, специфичные для Data Connect в файле конфигурации проекта firebase.json .
• Конфигурации Data Connect в dataconnect.yaml и connector.yaml .
• Роли IAM, которые вам необходимо настроить для своих проектов, использующих Data Connect .

Файлы конфигурации проекта Firebase

Справочник по конфигурации firebase.json

Используйте ключи dataconnect для настройки одной или нескольких служб Data Connect в вашем проекте.

dataconnect: {
   source: string // Path to the directory containing the dataconnect.yaml service file.
}

Ссылка на конфигурацию dataconnect.yaml

Файл dataconnect.yaml хранит информацию о конфигурации расположения источников схемы приложения, источников коннектора и информацию о подключении источника данных. Файл также служит указателем каталога проекта для Firebase CLI.

Ключ schemaValidation управляет уровнем проверки схемы, выполняемой при миграции схем во время развертывания. Если значение не задано, поведение команды dataconect:sql:migrate заключается в применении совместимых изменений и запросе подтверждения перед выполнением любых строгих изменений. Если задано, поведение следующее:

• Режим STRICT . Схема базы данных должна точно соответствовать схеме приложения, прежде чем схема приложения может быть развернута. Любые таблицы или столбцы, которые не используются в вашей схеме Data Connect будут удалены из базы данных.
• Режим COMPATIBLE . Схема базы данных должна быть совместима со схемой приложения до того, как схема приложения может быть развернута; любые дополнительные изменения считаются необязательными. Совместимость означает, что миграции схемы основаны на схеме приложения, которую вы пишете. Элементы в вашей базе данных, которые не используются вашей схемой приложения, остаются неизмененными. Поэтому после развертывания ваш бэкэнд может содержать неиспользуемые схемы, таблицы и столбцы.

Значения других ключей в этом файле поясняются в комментариях ниже.

# The top-level Firebase Data Connect YAML file.

# The Firebase Data Connect API version to target.
# Optional. Defaults to the latest version.
specVersion: string

# The ID of the Firebase Data Connect service resource.
# Required.
serviceId: string

# The location of the Firebase Data Connect service.
# Required.
location: string

# Required.
schema:
  # Relative path to directory for schema definitions.
  # Recursively loads all .gql files in this directory.
  # Optional. If not present, defaults to ./schema.
  source: string
  # Datasource connection information.
  # Required.
  datasource:
    # Required.
    postgresql:
      # The name of the PostgreSQL database.
      # Required.
      database: string
      cloudSql:
        # The ID of the CloudSQL instance resource.
        # Required.
        instanceId: string
        # Schema validation mode for schema migrations.
        # Defaults to unspecified/commented out, meaning you are prompted to
        # review all changes during migration.
        # If desired, uncomment and indicate one of "STRICT" or "COMPATIBLE".
        schemaValidation: string

# Required.
# Relative paths to directories for connector definitions.
# Recursively loads all .gql files in the listed directories.
# All directories specified MUST contain a connector.yaml file.
connectorDirs: [string]

Файл YAML предполагает следующую структуру каталогов по умолчанию (но ее можно настраивать):

./(project root)
   /dataconnect
      dataconnect.yaml
      /schema
        *.gql
      /connector
        connector.yaml
        *.gql

Справочник по конфигурации connector.yaml

Используйте connector.yaml для настройки режима аутентификации по умолчанию и параметров генерации SDK.

# The connector-level YAML file.

# Required. The connector name of the Firebase Data Connect connector resource.
connectorId: string

# Optional. If not specified, no generated libraries (i.e. type-safe SDKs) will be generated.
generate:
    # Optional.
    javascriptSdk:
        # Path to the directory that will be updated with the latest generated
        # web SDK.
        # Required.
      - outputDir: string
        # Path to your package.json directory. If specified, the new generated sdk will be installed in this path.
        # Optional. If not provided, the package will not be auto-installed for you.
      - packageJsonDir: string
        # Name of the package to be created.
        # Optional. Defaults to @firebasegen/<connectorID>
      - package: string
        <option>: string
    # Optional.
    swiftSdk:
        # Path to the directory that will be updated with the latest generated
        # iOS Swift SDK.
        # Required.
      - outputDir: string
        # Name of the package to be created.
      - package: string
        <option>: string
    # Optional.
    kotlinSdk:
        # Path to the directory that will be updated with the latest generated
        # Android SDK.
        # Required.
      - outputDir: string
        # Name of the package to be created.
      - package: string
        <option>: string

Конфигурация IAM для проектов Data Connect

Детализированные роли IAM для Data Connect

Базовые роли Firebase и предопределенные роли сопоставляются с ролями Data Connect более низкого уровня. Обратитесь к таблице для сопоставления.

Для управления назначениями отдельных ролей IAM для Data Connect на более детальном уровне используйте консоль Google Cloud .