CLI Firebase là một công cụ cho phép bạn quản lý và định cấu hình các sản phẩm và dịch vụ của Firebase từ dòng lệnh.
CLI cung cấp các lệnh có thể dùng để thực hiện nhiều tác vụ Data Connect, chẳng hạn như tạo dự án Data Connect mới, khởi chạy thư mục làm việc cục bộ tương ứng, thiết lập trình mô phỏng Data Connect, liệt kê tài nguyên Data Connect, tạo SDK ứng dụng và nhiều tác vụ khác.
Thiết lập lệnh
Thêm Data Connect vào dự án Firebase
firebase init
Sử dụng firebase init để thiết lập cấu hình dự án cục bộ mới. Quy trình công việc này
tạo hoặc cập nhật tệp cấu hình Firebase trong
thư mục của bạn.
firebase init
Quy trình firebase init sẽ hướng dẫn bạn cách thiết lập dịch vụ và cơ sở dữ liệu,
cũng như cài đặt trình mô phỏng Data Connect (không bắt buộc)
định cấu hình các SDK đã tạo.
Thiết lập dịch vụ và cơ sở dữ liệu
Nếu bạn chọn dataconnect để thiết lập sản phẩm, CLI sẽ nhắc bạn nhập một yêu cầu mới
tên dịch vụ và vị trí dịch vụ, cũng như liệu có liên kết và Cloud SQL hiện có cho
Thực thể PostgreSQL hoặc tạo một thực thể mới.
Nếu một thực thể hiện có được liên kết, CLI sẽ kiểm tra các chế độ cài đặt tương thích, chẳng hạn như xác thực IAM và địa chỉ IP công khai.
Thiết lập Local Emulator Suite
Quy trình CLI cung cấp tính năng thiết lập trình mô phỏng, bao gồm cả trình mô phỏng Data Connect.
Data Connect lệnh trên trình mô phỏng
Khởi động trình mô phỏng Data Connect
trình mô phỏng:start/exec
firebase emulators:start/exec
Sử dụng phiên bản Local Emulator Suite của trình mô phỏng Data Connect ở chế độ tương tác với start hoặc chế độ không tương tác, do tập lệnh điều khiển với exec.
Lệnh quản lý giản đồ và trình kết nối
Phần này chứa thông tin tham khảo về CLI cho các lệnh bạn sử dụng để quản lý giao thức và trình kết nối.
Để biết cách sử dụng các trường hợp và phương pháp đề xuất liên quan đến các lệnh này, hãy xem hướng dẫn quản lý giản đồ và trình kết nối.
Triển khai giản đồ và tài nguyên trình kết nối
triển khai
firebase deploy
Lệnh này triển khai tài nguyên cho các dịch vụ Data Connect được lập chỉ mục trong firebase.json. Di chuyển giản đồ sẽ được thực hiện nếu cần.
| Lệnh | Nội dung mô tả | |
|---|---|---|
triển khai Firebase |
Gắn cờ | Nội dung mô tả |
– chỉ kết nối dữ liệu |
Triển khai giản đồ và trình kết nối cho tất cả dịch vụ Data Connect để phục vụ việc này dự án của bạn, nhưng không triển khai các tài nguyên sản phẩm Firebase khác. | |
–-only dataconnect:serviceId |
Triển khai giản đồ và trình kết nối cho dịch vụ Data Connect được chỉ định. | |
–-only dataconnect:serviceId:connectorId |
Triển khai một trình kết nối duy nhất cho dịch vụ Data Connect đã chỉ định. | |
–-only dataconnect:serviceId:schema |
Triển khai giản đồ cho dịch vụ Data Connect đã chỉ định. | |
Với cờ –-only, bạn có thể truyền các giá trị được phân tách bằng dấu phẩy để triển khai bất kỳ
các tài nguyên bạn muốn.
firebase deploy --only dataconnect:service1:schema,dataconnect:service2
Liệt kê các dịch vụ, giản đồ và trình kết nối của Data Connect
kết nối dữ liệu:dịch vụ:danh sách
firebase dataconnect:services:list
Lệnh này in ra thông tin cơ bản về các dịch vụ, giản đồ và trình kết nối triển khai trên một dự án.
So sánh và di chuyển giản đồ SQL
dataconnect:sql:diff
firebase dataconnect:sql:diff
Lệnh này so sánh giản đồ cục bộ của một dịch vụ với giản đồ hiện tại của cơ sở dữ liệu Cloud SQL tương ứng. Thao tác này sẽ in các lệnh sẽ chạy để di chuyển cơ sở dữ liệu sang giản đồ mới.
| Lệnh | Nội dung mô tả | |
|---|---|---|
firebase dataconnect:sql:diff |
Cờ/Thông số | Nội dung mô tả |
serviceId |
Chỉ định dịch vụ. Nếu bỏ qua, in điểm khác biệt cho tất cả các dịch vụ trong firebase.json. | |
kết nối dữ liệu:sql:di chuyển
firebase dataconnect:sql:migrate
Lệnh này áp dụng các thay đổi về giản đồ cục bộ cho cơ sở dữ liệu Cloud SQL của dịch vụ.
Khi bạn thiết lập một dự án Data Connect cục bộ mới, với giá trị mặc định
Tệp dataconnect.yaml, hành vi của lệnh dataconect:sql:migrate
là nhắc bạn về mọi thay đổi cần thiết, sau đó nhắc bạn thực hiện mọi thay đổi tuỳ chọn
trước khi thực thi các thay đổi. Bạn có thể sửa đổi hành vi này để luôn
bao gồm hoặc bỏ qua các thay đổi không bắt buộc bằng cách cập nhật dataconnect.yaml
cấu hình, như đã thảo luận trong phần di chuyển giản đồ ở chế độ nghiêm ngặt hoặc tương thích
Trong các môi trường tương tác, CLI hiển thị từng câu lệnh SQL di chuyển
(và liệu công cụ đó có gây thiệt hại hay không) và nhắc thực hiện các thay đổi mà bạn muốn áp dụng.
Việc chuyển cờ --force tương đương với việc chấp nhận tất cả lời nhắc.
Trong các môi trường không tương tác:
- nếu không có
--force, hệ thống sẽ chỉ thực hiện các thay đổi không gây hại. Nếu có thay đổi có hại, CLI sẽ huỷ mà không có thay đổi nào được thực hiện. - với
--force, tất cả thay đổi sẽ được thực hiện. Nếu có bất kỳ thay đổi huỷ bỏ nào, các thay đổi đó sẽ được in và bạn sẽ được nhắc xem có muốn tiếp tục hay không, trừ phi bạn cung cấp cờ--force.
| Lệnh | Nội dung mô tả | |
|---|---|---|
firebase dataconnect:sql:migrate |
Gắn cờ | Nội dung mô tả |
mã dịch vụ |
Di chuyển cơ sở dữ liệu cho dịch vụ được chỉ định. ServiceId là suy ra nếu dự án của bạn chỉ có một dịch vụ. | |
–-force |
Tự động chấp nhận lời nhắc. | |
Giống như với các cờ --only khác, bạn có thể cung cấp nhiều dịch vụ được phân tách bằng
dấu phẩy.
Di chuyển giản đồ ở chế độ nghiêm ngặt hoặc tương thích
Data Connect quá trình di chuyển giản đồ có hai phương thức xác thực giản đồ khác nhau chế độ: nghiêm ngặt và tương thích. Việc xác thực chế độ nghiêm ngặt yêu cầu giản đồ cơ sở dữ liệu khớp chính xác với giản đồ ứng dụng trước khi ứng dụng giản đồ có thể được triển khai. Việc xác thực chế độ tương thích yêu cầu giản đồ cơ sở dữ liệu phải tương thích với giản đồ ứng dụng, nghĩa là các phần tử trong cơ sở dữ liệu không được giản đồ ứng dụng sử dụng sẽ không được sửa đổi.
Các chế độ xác thực giản đồ và phương pháp hay nhất để di chuyển giản đồ này được đề cập trong hướng dẫn quản lý giản đồ và trình kết nối
Chế độ xác thực được xác định bằng cách sử dụng khoá schemaValidation trong tệp dataconnect.yaml. Nếu bạn không chỉ định schemaValidation, CLI sẽ được áp dụng
các thay đổi tương thích và nhắc bạn trước khi thực thi bất kỳ thay đổi nghiêm ngặt nào. Xem
tài liệu tham khảo về cấu hình.
Các lệnh SDK
Tạo SDK
dataconnect:sdk:generate
firebase dataconnect:sdk:generate
Lệnh này tạo các SDK đã nhập được khai báo trong connector.yaml.
Ngoài ra, hãy xem các hướng dẫn làm việc với SDK web, SDK Android và SDK iOS.
| Lệnh | Nội dung mô tả | |
|---|---|---|
firebase dataconnect:sdk:generate |
Gắn cờ | Nội dung mô tả |
–-watch |
Giữ cho quy trình chạy và tạo SDK mới bất cứ khi nào bạn lưu các thay đổi đối với giản đồ và tệp GQL của trình kết nối. Nếu không tạo được, lỗi sẽ được in ra stdout, mã đã tạo sẽ không thay đổi và lệnh sẽ tiếp tục chạy. |
|
–-only ConnectorId:platform |
Chỉ tạo SDK cho một nền tảng và một trình kết nối. | |
Với cờ –only, bạn có thể truyền các giá trị được phân tách bằng dấu phẩy.
firebase dataconnect:sdk:generate –-only connector1, connector1:kotlin
Các lệnh quản lý Cloud SQL
Cấp vai trò SQL cho Cloud SQL
kết nối dữ liệu:sql:Windows
firebase dataconnect:sql:grant
Lệnh này cấp vai trò người dùng PostgreSQL cho người dùng hoặc tài khoản dịch vụ được chỉ định:
- Trình đọc: Có thể đọc từ các bảng trong giản đồ.
- Trình ghi: Có thể đọc và ghi vào các bảng trong giản đồ.
- Chủ sở hữu: Có thể di chuyển và thay đổi giản đồ. Điều này không bao gồm quyền cài đặt tiện ích.
| Lệnh | Nội dung mô tả | |
|---|---|---|
firebase dataconnect:sql:grant |
Gắn cờ/thông số | Nội dung mô tả |
-R, --role vai trò |
Vai trò SQL cần cấp, một trong các vai trò sau: chủ sở hữu, người viết hoặc người đọc. | |
-E, --email email_address |
Email của người dùng hoặc tài khoản dịch vụ mà bạn muốn cấp vai trò. | |
Tuỳ chọn chung
Các tuỳ chọn chung sau đây áp dụng cho tất cả lệnh:
--jsonchuyển đầu ra CLI sang JSON để phân tích cú pháp bằng các công cụ khác.--noninteractivevà--interactiveghi đè, nếu cần, tính năng tự động phát hiện môi trường không phải TTY.