Chỉ định các cấu hình tuỳ chỉnh cho phiên bản Cloud Firestore của bạn. Bạn phải đặt các mã này trước khi gọi bất kỳ phương thức nào khác.
Chữ ký:
export declare interface FirestoreSettings
Thuộc tính
| Tài sản | Loại | Mô tả |
|---|---|---|
| cacheSizeBytes | số | LƯU Ý: Trường này sẽ không được dùng nữa trong bản phát hành chính sau này. Thay vào đó, hãy sử dụng trường cache để chỉ định kích thước bộ nhớ đệm và các cấu hình bộ nhớ đệm khác.Ngưỡng kích thước bộ nhớ đệm gần đúng cho dữ liệu trên ổ đĩa. Nếu bộ nhớ đệm vượt quá kích thước này, Firestore sẽ bắt đầu xoá dữ liệu không được sử dụng gần đây. Dung lượng này không đảm bảo rằng bộ nhớ đệm sẽ duy trì dưới dung lượng đó. Tuy nhiên, nếu bộ nhớ đệm vượt quá dung lượng đã cho thì hệ thống sẽ thử xoá.Giá trị mặc định là 40 MB. Bạn phải đặt ngưỡng dung lượng ít nhất là 1 MB và bạn có thể đặt ngưỡng này thành CACHE_SIZE_UNLIMITED để tắt tính năng thu gom rác. |
| thử nghiệmAutoDetectLongPolling | boolean | Định cấu hình hệ thống truyền tải cơ bản của SDK (WebChannel) để tự động phát hiện xem có nên sử dụng phương thức thăm dò ý kiến dài hay không. Thuộc tính này tương tự như experimentalForceLongPolling, nhưng chỉ sử dụng chế độ thăm dò ý kiến dài nếu cần.Sau khi có giá trị mặc định là false kể từ khi bắt đầu vào năm 2019, giá trị mặc định của chế độ cài đặt này đã thay đổi vào tháng 5 năm 2023 thành true trong phiên bản 9.22.0 của SDK JavaScript Firebase. Điều đó có nghĩa là tính năng tự động phát hiện cuộc thăm dò ý kiến dài hiện được bật theo mặc định. Để tắt tính năng này, hãy đặt tùy chọn cài đặt này thành false và vui lòng mở vấn đề trên GitHub để chia sẻ các vấn đề đã thúc đẩy bạn tắt tính năng tự động phát hiện tự động thăm dò ý kiến trong thời gian dài.Không thể sử dụng tùy chọn cài đặt này trong môi trường Node.js. |
| Thử nghiệmForceLongPolling | boolean | Buộc hoạt động truyền tải mạng cơ bản của SDK (WebChannel) sử dụng kỹ thuật thăm dò ý kiến dài. Mỗi phản hồi của phần phụ trợ sẽ bị đóng ngay sau khi chương trình phụ trợ gửi dữ liệu (theo mặc định, các phản hồi sẽ được tiếp tục mở trong trường hợp phần phụ trợ có nhiều dữ liệu để gửi hơn). Điều này giúp tránh các vấn đề không tương thích với một số proxy, phần mềm diệt vi-rút, v.v. lưu lượng truy cập không chính xác vào bộ nhớ đệm vô thời hạn. Tuy nhiên, việc sử dụng tuỳ chọn này sẽ làm giảm một số hiệu suất.Không thể dùng chế độ cài đặt này với experimentalAutoDetectLongPolling và có thể bị xoá trong bản phát hành sau này. Nếu bạn tự thấy mình đang sử dụng tính năng này để giải quyết một vấn đề cụ thể về độ tin cậy của mạng, vui lòng cho chúng tôi biết về vấn đề đó trong https://github.com/firebase/firebase-js-sdk/issues/1674.Không thể sử dụng chế độ cài đặt này trong môi trường Node.js. |
| Thử nghiệmLongPollingOptions | Thử nghiệm LongPollingOptions | Các tuỳ chọn sẽ định cấu hình mạng truyền tải cơ bản của SDK (WebChannel) khi bạn sử dụng phương thức thăm dò ý kiến dài.Các tuỳ chọn này chỉ được dùng nếu experimentalForceLongPolling là true hoặc nếu experimentalAutoDetectLongPolling là true và tính năng phát hiện tự động xác định rằng cần phải thực hiện thao tác thăm dò ý kiến trong thời gian dài. Nếu không, các tuỳ chọn này sẽ không có hiệu lực. |
| máy chủ lưu trữ | chuỗi | Tên máy chủ để kết nối. |
| ignoreUndefinedProperties | boolean | Liệu có bỏ qua các thuộc tính lồng nhau được đặt thành undefined trong quá trình chuyển đổi tuần tự đối tượng hay không. Nếu bạn đặt thành true, thì các thuộc tính này sẽ bị bỏ qua và không được ghi vào Firestore. Nếu bạn đặt thành false hoặc bỏ qua, thì SDK sẽ gửi một ngoại lệ khi gặp các thuộc tính thuộc loại undefined. |
| localCache | FirestoreLocalCache | Chỉ định bộ nhớ đệm mà SDK sử dụng. Các tuỳ chọn có sẵn là MemoryLocalCache và PersistentLocalCache, mỗi tuỳ chọn có các tuỳ chọn cấu hình khác nhau.Khi bạn không chỉ định, MemoryLocalCache sẽ được sử dụng theo mặc định.LƯU Ý: việc đặt trường này và cacheSizeBytes cùng lúc sẽ gửi trường hợp ngoại lệ trong quá trình khởi chạy SDK. Thay vào đó, hãy sử dụng cấu hình trong đối tượng FirestoreLocalCache để chỉ định kích thước bộ nhớ đệm. |
| ssl | boolean | Liệu có sử dụng SSL khi kết nối hay không. |
FirestoreSettings.cacheSizeBytes
LƯU Ý: Trường này sẽ không được dùng nữa trong bản phát hành chính sau này. Thay vào đó, hãy sử dụng trường cache để chỉ định kích thước bộ nhớ đệm và các cấu hình bộ nhớ đệm khác.
Ngưỡng kích thước bộ nhớ đệm gần đúng cho dữ liệu trên ổ đĩa. Nếu bộ nhớ đệm vượt quá kích thước này, Firestore sẽ bắt đầu xoá dữ liệu không được sử dụng gần đây. Dung lượng này không đảm bảo rằng bộ nhớ đệm sẽ duy trì dưới kích thước đó. Tuy nhiên, nếu bộ nhớ đệm vượt quá dung lượng đã cho thì hệ thống sẽ thử xoá.
Giá trị mặc định là 40 MB. Bạn phải đặt ngưỡng dung lượng ít nhất là 1 MB và bạn có thể đặt ngưỡng này thành CACHE_SIZE_UNLIMITED để tắt tính năng thu gom rác.
Chữ ký:
cacheSizeBytes?: number;
FirestoreSettings.experimentalAutoDetectLongPolling
Định cấu hình hệ thống truyền tải cơ bản của SDK (WebChannel) để tự động phát hiện xem có nên sử dụng phương thức thăm dò ý kiến dài hay không. Hàm này rất giống với experimentalForceLongPolling, nhưng chỉ sử dụng tuỳ chọn thăm dò ý kiến dài nếu cần.
Sau khi có giá trị mặc định là false kể từ khi bắt đầu vào năm 2019, giá trị mặc định của chế độ cài đặt này đã thay đổi vào tháng 5 năm 2023 thành true trong phiên bản 9.22.0 của SDK JavaScript Firebase. Điều đó có nghĩa là tính năng tự động phát hiện cuộc thăm dò ý kiến dài hiện được bật theo mặc định. Để tắt tính năng này, hãy đặt chế độ cài đặt này thành false, đồng thời vui lòng mở một vấn đề trên GitHub để chia sẻ các vấn đề khiến bạn tắt tính năng tự động phát hiện tự động thăm dò ý kiến trong thời gian dài.
Bạn không thể sử dụng chế độ cài đặt này trong môi trường Node.js.
Chữ ký:
experimentalAutoDetectLongPolling?: boolean;
FirestoreSettings.experimentalForceLongPolling
Buộc hoạt động truyền tải mạng cơ bản của SDK (WebChannel) sử dụng kỹ thuật thăm dò ý kiến dài. Mỗi phản hồi của phần phụ trợ sẽ bị đóng ngay sau khi chương trình phụ trợ gửi dữ liệu (theo mặc định, các phản hồi sẽ được tiếp tục mở trong trường hợp phần phụ trợ có nhiều dữ liệu để gửi hơn). Điều này giúp tránh các vấn đề không tương thích với một số proxy, phần mềm diệt vi-rút, v.v. lưu lượng truy cập không chính xác vào bộ nhớ đệm vô thời hạn. Tuy nhiên, việc sử dụng tuỳ chọn này cũng sẽ làm giảm một số hiệu suất.
Không thể dùng chế độ cài đặt này với experimentalAutoDetectLongPolling và có thể bị xoá trong bản phát hành sau này. Nếu bạn thấy mình đang sử dụng công cụ này để khắc phục một vấn đề cụ thể về độ tin cậy của mạng, vui lòng cho chúng tôi biết trong https://github.com/firebase/firebase-js-sdk/issues/1674.
Bạn không thể sử dụng chế độ cài đặt này trong môi trường Node.js.
Chữ ký:
experimentalForceLongPolling?: boolean;
FirestoreSettings.experimentalLongPollingOptions
Các tuỳ chọn định cấu hình mạng truyền tải cơ bản của SDK (WebChannel) khi sử dụng phương thức thăm dò ý kiến dài.
Các tuỳ chọn này chỉ được dùng nếu experimentalForceLongPolling là true hoặc nếu experimentalAutoDetectLongPolling là true và tính năng phát hiện tự động xác định rằng cần phải thực hiện cuộc thăm dò ý kiến trong thời gian dài. Nếu không, các tuỳ chọn này sẽ không có hiệu lực.
Chữ ký:
experimentalLongPollingOptions?: ExperimentalLongPollingOptions;
FirestoreSettings.host
Tên máy chủ để kết nối.
Chữ ký:
host?: string;
FirestoreSettings.ignoreUndefinedProperties
Liệu có bỏ qua các thuộc tính lồng nhau được đặt thành undefined trong quá trình chuyển đổi tuần tự đối tượng hay không. Nếu bạn đặt thành true, thì các thuộc tính này sẽ bị bỏ qua và không được ghi vào Firestore. Nếu bạn đặt thành false hoặc bỏ qua, thì SDK sẽ gửi một ngoại lệ khi gặp các thuộc tính thuộc loại undefined.
Chữ ký:
ignoreUndefinedProperties?: boolean;
FirestoreSettings.localCache
Chỉ định bộ nhớ đệm mà SDK sử dụng. Các lựa chọn có sẵn là MemoryLocalCache và PersistentLocalCache, mỗi loại có các lựa chọn cấu hình khác nhau.
Khi bạn không chỉ định, MemoryLocalCache sẽ được sử dụng theo mặc định.
LƯU Ý: việc đặt trường này và cacheSizeBytes cùng một lúc sẽ gửi ngoại lệ trong quá trình khởi chạy SDK. Thay vào đó, hãy sử dụng cấu hình trong đối tượng FirestoreLocalCache để chỉ định kích thước bộ nhớ đệm.
Chữ ký:
localCache?: FirestoreLocalCache;
FirestoreSettings.ssl
Liệu có sử dụng SSL khi kết nối hay không.
Chữ ký:
ssl?: boolean;