로컬에서 Firebase Data Connect 시작하기

참고: Firebase Data Connect는 공개 미리보기 버전입니다. Data Connect에는 Google Cloud Platform 서비스 약관의 서비스별 약관 섹션에 있는 'GA 이전 제공 서비스 약관'이 적용됩니다. GA 이전 기능은 '있는 그대로' 제공되며 지원이 제한될 수 있습니다. 자세한 내용은 출시 단계 설명을 참고하세요.

참고: Spark 계획 프로젝트에서 Data Connect를 사용해 보려면 이 로컬 빠른 시작 가이드를 따르세요. 이 가이드에서는 에뮬레이터와 로컬 데이터베이스를 사용하여 로컬에서 프로토타입을 만듭니다. 대신 Blaze 요금제 프로젝트에 Data Connect를 추가하고 서비스와 Cloud SQL 데이터베이스를 설정할 준비가 되었다면 프로덕션 시작을 시도해 보세요.

이 빠른 시작에서는 프로덕션 SQL 인스턴스를 설정하지 않고 애플리케이션에서 로컬로 Firebase Data Connect를 빌드하는 방법을 알아봅니다. 실습할 내용은 다음과 같습니다.

• Firebase 프로젝트에 Firebase Data Connect를 추가합니다.
• 로컬 인스턴스에서 작동하도록 Visual Studio Code 확장 프로그램을 포함한 개발 환경을 설정합니다.
• 그런 다음 다음 작업을 수행하는 방법을 안내해 드리겠습니다.
  • 영화 앱의 스키마 만들기
  • 앱에서 사용할 쿼리 및 변형 정의
  • 로컬 에뮬레이터에서 샘플 데이터를 사용하여 쿼리 및 변형을 테스트합니다.
  • 강력한 유형의 SDK를 생성하고 앱에서 사용
  • 최종 스키마, 쿼리, 데이터를 클라우드에 배포합니다 (선택사항, Blaze 요금제 업그레이드 필요).

웹용 Codelab에 따라 빠른 시작 앱 저장소를 찾고 모든 기능이 포함된 Data Connect 앱을 빌드합니다. Android 및 iOS용 Codelab이 곧 제공될 예정입니다.

로컬 개발 흐름 선택

Data Connect는 개발 도구를 설치하고 로컬에서 작업하는 두 가지 방법을 제공합니다.

자동 설치 (macOS 또는 Linux) 수동 설치 (Windows)

기본 요건

이 빠른 시작을 사용하려면 다음이 필요합니다.

• Firebase 프로젝트 아직 프로젝트를 만들지 않았다면 Firebase Console에서 만듭니다.

개발 환경 설정

1. 로컬 프로젝트의 새 디렉터리를 만듭니다.

2. 새로 만든 디렉터리에서 다음 명령어를 실행합니다.

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

   이 스크립트는 개발 환경을 설정하고 브라우저 기반 IDE를 실행하려고 시도합니다. 이 IDE는 사전 번들로 묶인 VS Code 확장 프로그램을 비롯하여 스키마를 관리하고 애플리케이션에 사용할 쿼리 및 변형을 정의하고 강력한 유형의 SDK를 생성하는 데 도움이 되는 도구를 제공합니다.

   참고: 데스크톱 버전의 VS Code가 이미 설치되어 있으면 스크립트가 자동으로 열립니다.
   참고: 스크립트가 실패하면 수동 설치 단계를 따르세요.

도움말: 원하는 경우 셸 프로필 (예: ~/.zshrc 또는 ~/.bash_profile)에 다음 줄을 추가하여 별칭을 설정할 수 있습니다. 이렇게 하면 dataconnect를 입력하기만 하면 도구를 로컬에서 업그레이드하거나 브라우저 기반 IDE를 다시 실행할 수 있습니다.

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

프로젝트 디렉터리 설정

로컬 프로젝트를 설정하려면 프로젝트 디렉터리를 초기화합니다. IDE 창의 왼쪽 패널에서 Firebase 아이콘을 클릭하여 Data Connect VS Code 확장 프로그램 UI를 엽니다.

1. Google 계정으로 로그인 버튼을 클릭합니다.
2. Firebase 프로젝트 연결 버튼을 클릭하고 이전에 Console에서 만든 프로젝트를 선택합니다.
3. Run firebase init 버튼을 클릭합니다.

4. 에뮬레이터 시작 버튼을 클릭합니다.

   참고: 통합 터미널에서 구성된 에뮬레이터가 시작되는지 확인합니다. 실행되면 에뮬레이터 세부정보가 포함된 확장 프로그램 UI가 업데이트됩니다.

스키마 만들기

Firebase 프로젝트 디렉터리의 /dataconnect/schema/schema.gql 파일에서 영화에 관한 GraphQL 스키마를 정의합니다.

영화

Data Connect에서 GraphQL 필드는 열에 매핑됩니다. 영화에는 id, title, imageUrl, genre가 있습니다. Data Connect는 기본 데이터 유형인 String 및 UUID을 인식합니다.

다음 스니펫을 복사하거나 파일에서 해당 줄의 주석 처리를 삭제합니다.

# By default, a UUID id key will be created by default as primary key.
# If you want to specify a primary key, say title, which you can do through
# the @table(key: "title") directive
type Movie @table {
  id: UUID! @default(expr: "uuidV4()")
  title: String!
  imageUrl: String!
  genre: String
}

MovieMetadata

다음 스니펫을 복사하거나 파일에서 해당 줄의 주석 처리를 삭제합니다.

# 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 스키마 자세히 알아보기

테이블에 데이터 추가

IDE 편집기 패널에서 /dataconnect/schema/schema.gql의 GraphQL 유형 위에 CodeLens 버튼이 표시됩니다. 데이터 추가 및 실행 (로컬) 버튼을 사용하여 로컬 데이터베이스에 데이터를 추가할 수 있습니다.

Movie 및 MovieMetadata 테이블에 레코드를 추가하려면 다음 단계를 따르세요.

1. schema.gql에서 Movie 유형 선언 위의 데이터 추가 버튼을 클릭합니다.
   
2. 생성된 Movie_insert.gql 파일에서 세 필드의 데이터를 하드 코딩합니다.
3. Run (Local)(실행(로컬)) 버튼을 클릭합니다.
   
4. 이전 단계를 반복하여 MovieMetadata 테이블에 레코드를 추가하고 생성된 MovieMetadata_insert 변형에서 메시지가 표시되는 대로 movieId 필드에 영화의 id를 제공합니다.

데이터가 추가되었는지 빠르게 확인하려면 다음 단계를 따르세요.

1. schema.gql로 돌아가서 Movie 유형 선언 위의 데이터 읽기 버튼을 클릭합니다.
2. 생성된 Movie_read.gql 파일에서 Run (Local) 버튼을 클릭하여 쿼리를 실행합니다.

문서에서 Data Connect 변형에 대해 자세히 알아보기

쿼리 정의

이제 재미있는 부분입니다. 애플리케이션에 필요한 쿼리를 정의해 보겠습니다. 개발자는 GraphQL 쿼리 대신 SQL 쿼리를 작성하는 데 익숙하므로 처음에는 약간 다르게 느껴질 수 있습니다.

하지만 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 버튼을 사용하여 쿼리를 실행합니다.

여기서 가장 흥미로운 기능은 데이터베이스의 관계를 그래프처럼 취급할 수 있다는 점입니다. MovieMetadata 레코드에는 영화를 참조하는 movie 필드가 있으므로 필드에 중첩하여 영화 정보에 관한 정보를 다시 가져올 수 있습니다. 생성된 유형 movieMetadata_on_movie를 ListMovies 쿼리에 추가해 보세요.

query ListMovies @auth(level: PUBLIC) {
  movies {
    id
    title
    imageUrl
    genre
    movieMetadata_on_movie {
        rating
    }
  }
}

문서에서 Data Connect 쿼리에 대해 자세히 알아보기

SDK 생성 및 앱에서 사용

IDE 왼쪽 패널에서 Firebase 아이콘을 클릭하여 Data Connect VS Code 확장 프로그램 UI를 엽니다.

1. 앱에 SDK 추가 버튼을 클릭합니다.

2. 표시되는 대화상자에서 앱의 코드가 포함된 디렉터리를 선택합니다. Data Connect SDK 코드가 생성되어 여기에 저장됩니다.

   참고: 아직 앱 디렉터리가 없는 경우 지금은 SDK 코드의 새 디렉터리를 만들고 선택한 후 나중에 앱에 연결할 수 있습니다.

3. 앱 플랫폼을 선택하면 선택한 디렉터리에 SDK 코드가 즉시 생성됩니다.

생성된 SDK를 사용하여 클라이언트 앱 (웹, Android, iOS, Flutter)에서 쿼리 및 변형을 호출하는 방법을 알아봅니다.

스키마 및 쿼리를 프로덕션에 배포

앱에서 로컬 설정을 완료하면 이제 스키마, 데이터, 쿼리를 클라우드에 배포할 수 있습니다. Cloud SQL 인스턴스를 설정하려면 Blaze 요금제 프로젝트가 필요합니다.

1. Firebase 콘솔의 Data Connect 섹션으로 이동하여 무료 체험판 Cloud SQL 인스턴스를 만듭니다.

   참고: PostgreSQL용 Cloud SQL 인스턴스를 프로비저닝하는 데 최대 15분이 걸릴 수 있습니다. 인스턴스가 준비될 때까지는 배포할 수 없습니다.

2. IDE 통합 터미널에서 firebase init dataconnect을 실행하고 방금 콘솔에서 만든 지역/서비스 ID를 선택합니다.

3. '파일 dataconnect/dataconnect.yaml이 이미 존재합니다. 덮어쓰시겠습니까?'라는 메시지가 표시되면 'Y'를 선택합니다.

4. IDE 창의 VS Code 확장 프로그램 UI에서 프로덕션에 배포 버튼을 클릭합니다.

5. 배포가 완료되면 Firebase 콘솔로 이동하여 스키마, 작업, 데이터가 클라우드에 업로드되었는지 확인합니다. 콘솔에서 스키마를 확인하고 작업을 실행할 수도 있습니다. PostgreSQL용 Cloud SQL 인스턴스가 최종적으로 배포된 생성된 스키마 및 데이터로 업데이트됩니다.

다음 단계

배포된 프로젝트를 검토하고 더 많은 도구를 살펴보세요.

• Firebase Console에서 데이터베이스에 데이터를 추가하고, 스키마를 검사 및 수정하고, Data Connect 서비스를 모니터링합니다.

문서에서 자세한 내용을 확인하세요. 예를 들어 빠른 시작을 완료한 경우 다음과 같이 진행할 수 있습니다.

• 스키마, 쿼리, 변형 개발에 대해 자세히 알아보기
• 클라이언트 SDK를 생성하고 웹, Android, iOS, Flutter용 클라이언트 코드에서 쿼리 및 변형을 호출하는 방법을 알아보세요.