database package

Cơ sở dữ liệu thời gian thực của Firebase

Chức năng

Chức năng Sự miêu tả
chức năng (ứng dụng, ...)
getDatabase(ứng dụng, url) Trả về phiên bản SDK cơ sở dữ liệu thời gian thực được liên kết với Ứng dụng Firebase được cung cấp . Khởi tạo một phiên bản mới với cài đặt mặc định nếu không có phiên bản nào tồn tại hoặc nếu phiên bản hiện tại sử dụng URL cơ sở dữ liệu tùy chỉnh.
hàm(db, ...)
connectDatabaseEmulator(db, máy chủ, cổng, tùy chọn) Sửa đổi phiên bản được cung cấp để giao tiếp với trình mô phỏng Cơ sở dữ liệu thời gian thực.

Lưu ý: Phương thức này phải được gọi trước khi thực hiện bất kỳ thao tác nào khác.

goOffline(db) Ngắt kết nối khỏi máy chủ (tất cả các hoạt động của Cơ sở dữ liệu sẽ được hoàn thành ngoại tuyến). Máy khách tự động duy trì kết nối liên tục với máy chủ Cơ sở dữ liệu, máy chủ này sẽ vẫn hoạt động vô thời hạn và kết nối lại khi bị ngắt kết nối. Tuy nhiên, các phương thức goOffline()goOnline() có thể được sử dụng để kiểm soát kết nối máy khách trong trường hợp không mong muốn kết nối liên tục. Khi ngoại tuyến, khách hàng sẽ không còn nhận được cập nhật dữ liệu từ Cơ sở dữ liệu. Tuy nhiên, tất cả các hoạt động Cơ sở dữ liệu được thực hiện cục bộ sẽ tiếp tục kích hoạt các sự kiện ngay lập tức, cho phép ứng dụng của bạn tiếp tục hoạt động bình thường. Ngoài ra, mỗi thao tác được thực hiện cục bộ sẽ tự động được xếp hàng đợi và thử lại khi kết nối lại với máy chủ Cơ sở dữ liệu. Để kết nối lại với Cơ sở dữ liệu và bắt đầu nhận các sự kiện từ xa, hãy xem goOnline() .
goOnline(db) Kết nối lại với máy chủ và đồng bộ hóa trạng thái Cơ sở dữ liệu ngoại tuyến với trạng thái máy chủ. Phương pháp này nên được sử dụng sau khi tắt kết nối đang hoạt động bằng goOffline() . Sau khi được kết nối lại, máy khách sẽ truyền dữ liệu thích hợp và kích hoạt các sự kiện thích hợp để máy khách của bạn tự động "bắt kịp".
ref(db, đường dẫn) Trả về một Reference biểu thị vị trí trong Cơ sở dữ liệu tương ứng với đường dẫn được cung cấp. Nếu không có đường dẫn nào được cung cấp, Reference sẽ trỏ đến thư mục gốc của Cơ sở dữ liệu.
refFromURL(db, url) Trả về Reference biểu thị vị trí trong Cơ sở dữ liệu tương ứng với URL Firebase được cung cấp. Một ngoại lệ sẽ được đưa ra nếu URL không phải là URL Cơ sở dữ liệu Firebase hợp lệ hoặc URL đó có miền khác với phiên bản Database hiện tại. Lưu ý rằng tất cả các tham số truy vấn ( orderBy , limitToLast , v.v.) đều bị bỏ qua và không được áp dụng cho Reference được trả về.
chức năng()
lựcLongPolling() Buộc sử dụng longPolling thay vì websockets. Điều này sẽ bị bỏ qua nếu giao thức websocket được sử dụng trong cơ sở dữ liệuURL.
lựcWebSockets() Buộc sử dụng websockets thay vì longPolling.
orderByKey() Tạo một QueryConstraint mới sắp xếp theo khóa. Sắp xếp kết quả của truy vấn theo giá trị khóa (tăng dần) của chúng. Bạn có thể đọc thêm về orderByKey() trong Sắp xếp dữ liệu .
orderByPriority() Tạo một QueryConstraint mới sắp xếp thứ tự ưu tiên. Các ứng dụng không cần sử dụng mức độ ưu tiên nhưng có thể sắp xếp các bộ sưu tập theo các thuộc tính thông thường (xem Sắp xếp dữ liệu để biết các lựa chọn thay thế mức độ ưu tiên.
orderByValue() Tạo một QueryConstraint mới sắp xếp theo giá trị. Nếu các phần tử con của truy vấn đều là giá trị vô hướng (chuỗi, số hoặc boolean), bạn có thể sắp xếp kết quả theo giá trị (tăng dần) của chúng. Bạn có thể đọc thêm về orderByValue() trong Sắp xếp dữ liệu .
máy chủDấu thời gian() Trả về giá trị giữ chỗ để tự động điền dấu thời gian hiện tại (thời gian kể từ kỷ nguyên Unix, tính bằng mili giây) do máy chủ Firebase xác định.
hàm (delta, ...)
tăng (đồng bằng) Trả về một giá trị giữ chỗ có thể được sử dụng để tăng dần giá trị cơ sở dữ liệu hiện tại theo delta được cung cấp.
chức năng (đã bật, ...)
EnableLogging(đã bật, liên tục) Ghi nhật ký thông tin gỡ lỗi vào bảng điều khiển.
hàm (giới hạn, ...)
limitToFirst(giới hạn) Tạo một QueryConstraint mới nếu giới hạn ở số lượng trẻ em cụ thể đầu tiên. Phương thức limitToFirst() được sử dụng để đặt số lượng phần tử con tối đa được đồng bộ hóa cho một lệnh gọi lại nhất định. Nếu chúng tôi đặt giới hạn là 100, ban đầu chúng tôi sẽ chỉ nhận được tối đa 100 sự kiện child_added . Nếu chúng tôi có ít hơn 100 tin nhắn được lưu trữ trong Cơ sở dữ liệu của mình thì sự kiện child_added sẽ kích hoạt cho mỗi tin nhắn. Tuy nhiên, nếu chúng tôi có hơn 100 tin nhắn, chúng tôi sẽ chỉ nhận được sự kiện child_added cho 100 tin nhắn được đặt hàng đầu tiên. Khi các mục thay đổi, chúng tôi sẽ nhận được các sự kiện child_removed cho mỗi mục bị loại khỏi danh sách đang hoạt động để tổng số vẫn ở mức 100. Bạn có thể đọc thêm về limitToFirst() trong Lọc dữ liệu .
limitToLast(giới hạn) Tạo một QueryConstraint mới được giới hạn chỉ trả về số lượng con được chỉ định cuối cùng. Phương thức limitToLast() được sử dụng để đặt số lượng phần tử con tối đa được đồng bộ hóa cho một lệnh gọi lại nhất định. Nếu chúng tôi đặt giới hạn là 100, ban đầu chúng tôi sẽ chỉ nhận được tối đa 100 sự kiện child_added . Nếu chúng tôi có ít hơn 100 tin nhắn được lưu trữ trong Cơ sở dữ liệu của mình thì sự kiện child_added sẽ kích hoạt cho mỗi tin nhắn. Tuy nhiên, nếu chúng tôi có hơn 100 tin nhắn, chúng tôi sẽ chỉ nhận được sự kiện child_added cho 100 tin nhắn được đặt hàng gần đây nhất. Khi các mục thay đổi, chúng tôi sẽ nhận được các sự kiện child_removed cho mỗi mục bị loại khỏi danh sách đang hoạt động để tổng số vẫn ở mức 100. Bạn có thể đọc thêm về limitToLast() trong Lọc dữ liệu .
chức năng (logger, ...)
kích hoạtLogging(logger) Ghi nhật ký thông tin gỡ lỗi vào bảng điều khiển.
hàm (cha mẹ, ...)
con (cha mẹ, đường dẫn) Nhận Reference cho vị trí tại đường dẫn tương đối đã chỉ định. Đường dẫn tương đối có thể là tên con đơn giản (ví dụ: "ada") hoặc đường dẫn sâu hơn được phân tách bằng dấu gạch chéo (ví dụ: "ada/name/first").
đẩy (cha mẹ, giá trị) Tạo một vị trí con mới bằng cách sử dụng một khóa duy nhất và trả về Reference của nó. Đây là mẫu phổ biến nhất để thêm dữ liệu vào bộ sưu tập các mục. Nếu bạn cung cấp giá trị cho push() , giá trị đó sẽ được ghi vào vị trí được tạo. Nếu bạn không chuyển một giá trị thì không có gì được ghi vào cơ sở dữ liệu và phần tử con vẫn trống (nhưng bạn có thể sử dụng Reference ở nơi khác). Các khóa duy nhất được tạo bởi push() được sắp xếp theo thời gian hiện tại, do đó danh sách các mục kết quả được sắp xếp theo thứ tự thời gian. Các khóa cũng được thiết kế để không thể đoán được (chúng chứa 72 bit entropy ngẫu nhiên). Xem Thêm vào danh sách dữ liệu . Xem 2^120 cách để đảm bảo số nhận dạng duy nhất .
hàm(đường dẫn, ...)
orderByChild(đường dẫn) Tạo một QueryConstraint mới sắp xếp theo khóa con được chỉ định. Truy vấn chỉ có thể sắp xếp theo một khóa tại một thời điểm. Gọi orderByChild() nhiều lần trên cùng một truy vấn là một lỗi. Truy vấn Firebase cho phép bạn sắp xếp dữ liệu của mình theo bất kỳ khóa con nào một cách nhanh chóng. Tuy nhiên, nếu biết trước chỉ mục của mình là gì, bạn có thể xác định chúng thông qua quy tắc .indexOn trong Quy tắc bảo mật để có hiệu suất tốt hơn. Xem quy tắc https://firebase.google.com/docs/database/security/indexing-data để biết thêm thông tin. Bạn có thể đọc thêm về orderByChild() trong Sắp xếp dữ liệu .
hàm (truy vấn, ...)
nhận (truy vấn) Nhận kết quả cập nhật nhất cho truy vấn này.
tắt (truy vấn, loại sự kiện, gọi lại) Tách một lệnh gọi lại được đính kèm trước đó với trình nghe on () ( onValue , onChildAdded ) tương ứng. Lưu ý: Đây không phải là cách được khuyến nghị để loại bỏ người nghe. Thay vào đó, vui lòng sử dụng hàm gọi lại được trả về từ các lệnh gọi lại on ứng. Tách một cuộc gọi lại được đính kèm trước đó với on*() . Việc gọi off() trên trình nghe gốc sẽ không tự động xóa trình nghe đã đăng ký trên các nút con, off() cũng phải được gọi trên bất kỳ trình nghe con nào để xóa lệnh gọi lại. Nếu lệnh gọi lại không được chỉ định thì tất cả lệnh gọi lại cho loại sự kiện đã chỉ định sẽ bị xóa. Tương tự, nếu không có loại sự kiện nào được chỉ định thì tất cả lệnh gọi lại cho Reference sẽ bị xóa. Người nghe riêng lẻ cũng có thể bị xóa bằng cách gọi lệnh gọi lại hủy đăng ký của họ.
onChildAdded(truy vấn, gọi lại, cancelCallback) Lắng nghe những thay đổi dữ liệu tại một vị trí cụ thể. Đây là cách chính để đọc dữ liệu từ Cơ sở dữ liệu. Lệnh gọi lại của bạn sẽ được kích hoạt cho dữ liệu ban đầu và lặp lại bất cứ khi nào dữ liệu thay đổi. Gọi lại lệnh gọi lại hủy đăng ký để ngừng nhận thông tin cập nhật. Xem Truy xuất dữ liệu trên web để biết thêm chi tiết. Sự kiện onChildAdded sẽ được kích hoạt một lần cho mỗi thành phần con ban đầu tại vị trí này và nó sẽ được kích hoạt lại mỗi khi có thành phần con mới được thêm vào. DataSnapshot được chuyển vào lệnh gọi lại sẽ phản ánh dữ liệu của trẻ có liên quan. Vì mục đích sắp xếp thứ tự, nó được truyền đối số thứ hai là một chuỗi chứa khóa của con trước đó theo thứ tự sắp xếp hoặc null nếu đó là con đầu tiên.
onChildAdded(truy vấn, gọi lại, tùy chọn) Lắng nghe những thay đổi dữ liệu tại một vị trí cụ thể. Đây là cách chính để đọc dữ liệu từ Cơ sở dữ liệu. Lệnh gọi lại của bạn sẽ được kích hoạt cho dữ liệu ban đầu và lặp lại bất cứ khi nào dữ liệu thay đổi. Gọi lại lệnh gọi lại hủy đăng ký để ngừng nhận thông tin cập nhật. Xem Truy xuất dữ liệu trên web để biết thêm chi tiết. Sự kiện onChildAdded sẽ được kích hoạt một lần cho mỗi thành phần con ban đầu tại vị trí này và nó sẽ được kích hoạt lại mỗi khi có thành phần con mới được thêm vào. DataSnapshot được chuyển vào lệnh gọi lại sẽ phản ánh dữ liệu của trẻ có liên quan. Vì mục đích sắp xếp thứ tự, nó được truyền đối số thứ hai là một chuỗi chứa khóa của con trước đó theo thứ tự sắp xếp hoặc null nếu đó là con đầu tiên.
onChildAdded(truy vấn, gọi lại, cancelCallback, tùy chọn) Lắng nghe những thay đổi dữ liệu tại một vị trí cụ thể. Đây là cách chính để đọc dữ liệu từ Cơ sở dữ liệu. Lệnh gọi lại của bạn sẽ được kích hoạt cho dữ liệu ban đầu và lặp lại bất cứ khi nào dữ liệu thay đổi. Gọi lại lệnh gọi lại hủy đăng ký để ngừng nhận thông tin cập nhật. Xem Truy xuất dữ liệu trên web để biết thêm chi tiết. Sự kiện onChildAdded sẽ được kích hoạt một lần cho mỗi thành phần con ban đầu tại vị trí này và nó sẽ được kích hoạt lại mỗi khi có thành phần con mới được thêm vào. DataSnapshot được chuyển vào lệnh gọi lại sẽ phản ánh dữ liệu của trẻ có liên quan. Vì mục đích sắp xếp thứ tự, nó được truyền đối số thứ hai là một chuỗi chứa khóa của con trước đó theo thứ tự sắp xếp hoặc null nếu đó là con đầu tiên.
onChildChanged(truy vấn, gọi lại, cancelCallback) Lắng nghe những thay đổi dữ liệu tại một vị trí cụ thể. Đây là cách chính để đọc dữ liệu từ Cơ sở dữ liệu. Lệnh gọi lại của bạn sẽ được kích hoạt cho dữ liệu ban đầu và lặp lại bất cứ khi nào dữ liệu thay đổi. Gọi lại lệnh gọi lại hủy đăng ký để ngừng nhận thông tin cập nhật. Xem Truy xuất dữ liệu trên web để biết thêm chi tiết. Sự kiện onChildChanged sẽ được kích hoạt khi dữ liệu được lưu trữ trong phần tử con (hoặc bất kỳ phần tử con nào của nó) thay đổi. Lưu ý rằng một sự kiện child_changed có thể thể hiện nhiều thay đổi đối với thành phần con. DataSnapshot được chuyển đến lệnh gọi lại sẽ chứa nội dung con mới. Vì mục đích sắp xếp thứ tự, lệnh gọi lại cũng được truyền đối số thứ hai là một chuỗi chứa khóa của con anh chị em trước đó theo thứ tự sắp xếp hoặc null nếu đó là con đầu tiên.
onChildChanged(truy vấn, gọi lại, tùy chọn) Lắng nghe những thay đổi dữ liệu tại một vị trí cụ thể. Đây là cách chính để đọc dữ liệu từ Cơ sở dữ liệu. Lệnh gọi lại của bạn sẽ được kích hoạt cho dữ liệu ban đầu và lặp lại bất cứ khi nào dữ liệu thay đổi. Gọi lại lệnh gọi lại hủy đăng ký để ngừng nhận thông tin cập nhật. Xem Truy xuất dữ liệu trên web để biết thêm chi tiết. Sự kiện onChildChanged sẽ được kích hoạt khi dữ liệu được lưu trữ trong phần tử con (hoặc bất kỳ phần tử con nào của nó) thay đổi. Lưu ý rằng một sự kiện child_changed có thể thể hiện nhiều thay đổi đối với thành phần con. DataSnapshot được chuyển đến lệnh gọi lại sẽ chứa nội dung con mới. Vì mục đích sắp xếp thứ tự, lệnh gọi lại cũng được truyền đối số thứ hai là một chuỗi chứa khóa của con anh chị em trước đó theo thứ tự sắp xếp hoặc null nếu đó là con đầu tiên.
onChildChanged(truy vấn, gọi lại, cancelCallback, tùy chọn) Lắng nghe những thay đổi dữ liệu tại một vị trí cụ thể. Đây là cách chính để đọc dữ liệu từ Cơ sở dữ liệu. Lệnh gọi lại của bạn sẽ được kích hoạt cho dữ liệu ban đầu và lặp lại bất cứ khi nào dữ liệu thay đổi. Gọi lại lệnh gọi lại hủy đăng ký để ngừng nhận thông tin cập nhật. Xem Truy xuất dữ liệu trên web để biết thêm chi tiết. Sự kiện onChildChanged sẽ được kích hoạt khi dữ liệu được lưu trữ trong phần tử con (hoặc bất kỳ phần tử con nào của nó) thay đổi. Lưu ý rằng một sự kiện child_changed có thể thể hiện nhiều thay đổi đối với thành phần con. DataSnapshot được chuyển đến lệnh gọi lại sẽ chứa nội dung con mới. Vì mục đích sắp xếp thứ tự, lệnh gọi lại cũng được truyền đối số thứ hai là một chuỗi chứa khóa của con anh chị em trước đó theo thứ tự sắp xếp hoặc null nếu đó là con đầu tiên.
onChildMoved(truy vấn, gọi lại, cancelCallback) Lắng nghe những thay đổi dữ liệu tại một vị trí cụ thể. Đây là cách chính để đọc dữ liệu từ Cơ sở dữ liệu. Lệnh gọi lại của bạn sẽ được kích hoạt cho dữ liệu ban đầu và lặp lại bất cứ khi nào dữ liệu thay đổi. Gọi lại lệnh gọi lại hủy đăng ký để ngừng nhận thông tin cập nhật. Xem Truy xuất dữ liệu trên web để biết thêm chi tiết. Sự kiện onChildMoved sẽ được kích hoạt khi thứ tự sắp xếp của trẻ thay đổi sao cho vị trí của nó so với anh chị em của nó thay đổi. DataSnapshot được chuyển tới lệnh gọi lại sẽ dành cho dữ liệu của trẻ đã di chuyển. Nó cũng được truyền đối số thứ hai là một chuỗi chứa khóa của con anh chị em trước đó theo thứ tự sắp xếp hoặc null nếu đó là con đầu tiên.
onChildMoved(truy vấn, gọi lại, tùy chọn) Lắng nghe những thay đổi dữ liệu tại một vị trí cụ thể. Đây là cách chính để đọc dữ liệu từ Cơ sở dữ liệu. Lệnh gọi lại của bạn sẽ được kích hoạt cho dữ liệu ban đầu và lặp lại bất cứ khi nào dữ liệu thay đổi. Gọi lại lệnh gọi lại hủy đăng ký để ngừng nhận thông tin cập nhật. Xem Truy xuất dữ liệu trên web để biết thêm chi tiết. Sự kiện onChildMoved sẽ được kích hoạt khi thứ tự sắp xếp của trẻ thay đổi sao cho vị trí của nó so với anh chị em của nó thay đổi. DataSnapshot được chuyển tới lệnh gọi lại sẽ dành cho dữ liệu của trẻ đã di chuyển. Nó cũng được truyền đối số thứ hai là một chuỗi chứa khóa của con anh chị em trước đó theo thứ tự sắp xếp hoặc null nếu đó là con đầu tiên.
onChildMoved(truy vấn, gọi lại, cancelCallback, tùy chọn) Lắng nghe những thay đổi dữ liệu tại một vị trí cụ thể. Đây là cách chính để đọc dữ liệu từ Cơ sở dữ liệu. Lệnh gọi lại của bạn sẽ được kích hoạt cho dữ liệu ban đầu và lặp lại bất cứ khi nào dữ liệu thay đổi. Gọi lại lệnh gọi lại hủy đăng ký để ngừng nhận thông tin cập nhật. Xem Truy xuất dữ liệu trên web để biết thêm chi tiết. Sự kiện onChildMoved sẽ được kích hoạt khi thứ tự sắp xếp của trẻ thay đổi sao cho vị trí của nó so với anh chị em của nó thay đổi. DataSnapshot được chuyển đến lệnh gọi lại sẽ dành cho dữ liệu của trẻ đã di chuyển. Nó cũng được truyền đối số thứ hai là một chuỗi chứa khóa của con anh chị em trước đó theo thứ tự sắp xếp hoặc null nếu đó là con đầu tiên.
onChildRemoved(truy vấn, gọi lại, cancelCallback) Lắng nghe những thay đổi dữ liệu tại một vị trí cụ thể. Đây là cách chính để đọc dữ liệu từ Cơ sở dữ liệu. Lệnh gọi lại của bạn sẽ được kích hoạt cho dữ liệu ban đầu và lặp lại bất cứ khi nào dữ liệu thay đổi. Gọi lại lệnh gọi lại hủy đăng ký để ngừng nhận thông tin cập nhật. Xem Truy xuất dữ liệu trên web để biết thêm chi tiết. Sự kiện onChildRemoved sẽ được kích hoạt mỗi lần một phần tử con bị xóa. DataSnapshot được chuyển vào lệnh gọi lại sẽ là dữ liệu cũ của thành phần con đã bị xóa. Một đứa trẻ sẽ bị loại bỏ khi: - một khách hàng gọi rõ ràng remove() trên con đó hoặc một trong các tổ tiên của nó - một khách hàng gọi set(null) trên con đó hoặc một trong các tổ tiên của nó - con đó đã loại bỏ tất cả các con của nó - hiện có một truy vấn có hiệu lực lọc ra phần tử con (vì thứ tự sắp xếp của nó đã thay đổi hoặc đã đạt đến giới hạn tối đa)
onChildRemoved(truy vấn, gọi lại, tùy chọn) Lắng nghe những thay đổi dữ liệu tại một vị trí cụ thể. Đây là cách chính để đọc dữ liệu từ Cơ sở dữ liệu. Lệnh gọi lại của bạn sẽ được kích hoạt cho dữ liệu ban đầu và lặp lại bất cứ khi nào dữ liệu thay đổi. Gọi lại lệnh gọi lại hủy đăng ký để ngừng nhận thông tin cập nhật. Xem Truy xuất dữ liệu trên web để biết thêm chi tiết. Sự kiện onChildRemoved sẽ được kích hoạt mỗi lần một phần tử con bị xóa. DataSnapshot được chuyển vào lệnh gọi lại sẽ là dữ liệu cũ của thành phần con đã bị xóa. Một đứa trẻ sẽ bị loại bỏ khi: - một khách hàng gọi rõ ràng remove() trên con đó hoặc một trong các tổ tiên của nó - một khách hàng gọi set(null) trên con đó hoặc một trong các tổ tiên của nó - con đó đã loại bỏ tất cả các con của nó - hiện có một truy vấn có hiệu lực lọc ra phần tử con (vì thứ tự sắp xếp của nó đã thay đổi hoặc đã đạt đến giới hạn tối đa)
onChildRemoved(truy vấn, gọi lại, cancelCallback, tùy chọn) Lắng nghe những thay đổi dữ liệu tại một vị trí cụ thể. Đây là cách chính để đọc dữ liệu từ Cơ sở dữ liệu. Lệnh gọi lại của bạn sẽ được kích hoạt cho dữ liệu ban đầu và lặp lại bất cứ khi nào dữ liệu thay đổi. Gọi lại lệnh gọi lại hủy đăng ký để ngừng nhận thông tin cập nhật. Xem Truy xuất dữ liệu trên web để biết thêm chi tiết. Sự kiện onChildRemoved sẽ được kích hoạt mỗi lần một phần tử con bị xóa. DataSnapshot được chuyển vào lệnh gọi lại sẽ là dữ liệu cũ của thành phần con đã bị xóa. Một đứa trẻ sẽ bị loại bỏ khi: - một khách hàng gọi rõ ràng remove() trên con đó hoặc một trong các tổ tiên của nó - một khách hàng gọi set(null) trên con đó hoặc một trong các tổ tiên của nó - con đó đã loại bỏ tất cả các con của nó - hiện có một truy vấn có hiệu lực lọc ra phần tử con (vì thứ tự sắp xếp của nó đã thay đổi hoặc đã đạt đến giới hạn tối đa)
onValue(truy vấn, gọi lại, cancelCallback) Lắng nghe những thay đổi dữ liệu tại một vị trí cụ thể. Đây là cách chính để đọc dữ liệu từ Cơ sở dữ liệu. Lệnh gọi lại của bạn sẽ được kích hoạt cho dữ liệu ban đầu và lặp lại bất cứ khi nào dữ liệu thay đổi. Gọi lại lệnh gọi lại hủy đăng ký để ngừng nhận thông tin cập nhật. Xem Truy xuất dữ liệu trên web để biết thêm chi tiết. Sự kiện onValue sẽ kích hoạt một lần với dữ liệu ban đầu được lưu trữ tại vị trí này, sau đó kích hoạt lại mỗi khi dữ liệu thay đổi. DataSnapshot được chuyển tới lệnh gọi lại sẽ dành cho vị trí mà on() được gọi. Nó sẽ không kích hoạt cho đến khi toàn bộ nội dung được đồng bộ hóa. Nếu vị trí không có dữ liệu, nó sẽ được kích hoạt bằng một DataSnapshot trống ( val() sẽ trả về null ).
onValue(truy vấn, gọi lại, tùy chọn) Lắng nghe những thay đổi dữ liệu tại một vị trí cụ thể. Đây là cách chính để đọc dữ liệu từ Cơ sở dữ liệu. Lệnh gọi lại của bạn sẽ được kích hoạt cho dữ liệu ban đầu và lặp lại bất cứ khi nào dữ liệu thay đổi. Gọi lại lệnh gọi lại hủy đăng ký để ngừng nhận thông tin cập nhật. Xem Truy xuất dữ liệu trên web để biết thêm chi tiết. Sự kiện onValue sẽ kích hoạt một lần với dữ liệu ban đầu được lưu trữ tại vị trí này, sau đó kích hoạt lại mỗi khi dữ liệu thay đổi. DataSnapshot được chuyển tới lệnh gọi lại sẽ dành cho vị trí mà on() được gọi. Nó sẽ không kích hoạt cho đến khi toàn bộ nội dung được đồng bộ hóa. Nếu vị trí không có dữ liệu, nó sẽ được kích hoạt bằng một DataSnapshot trống ( val() sẽ trả về null ).
onValue(truy vấn, gọi lại, cancelCallback, tùy chọn) Lắng nghe những thay đổi dữ liệu tại một vị trí cụ thể. Đây là cách chính để đọc dữ liệu từ Cơ sở dữ liệu. Lệnh gọi lại của bạn sẽ được kích hoạt cho dữ liệu ban đầu và lặp lại bất cứ khi nào dữ liệu thay đổi. Gọi lại lệnh gọi lại hủy đăng ký để ngừng nhận thông tin cập nhật. Xem Truy xuất dữ liệu trên web để biết thêm chi tiết. Sự kiện onValue sẽ kích hoạt một lần với dữ liệu ban đầu được lưu trữ tại vị trí này, sau đó kích hoạt lại mỗi khi dữ liệu thay đổi. DataSnapshot được chuyển tới lệnh gọi lại sẽ dành cho vị trí mà on() được gọi. Nó sẽ không kích hoạt cho đến khi toàn bộ nội dung được đồng bộ hóa. Nếu vị trí không có dữ liệu, nó sẽ được kích hoạt bằng một DataSnapshot trống ( val() sẽ trả về null ).
truy vấn(truy vấn, queryConstraints) Tạo một phiên bản Query bất biến mới được mở rộng để bao gồm cả các ràng buộc truy vấn bổ sung.
hàm(ref, ...)
onDisconnect(ref) Trả về đối tượng OnDisconnect - xem Kích hoạt khả năng ngoại tuyến trong JavaScript để biết thêm thông tin về cách sử dụng nó.
xóa(ref) Xóa dữ liệu tại vị trí Cơ sở dữ liệu này. Mọi dữ liệu tại các vị trí con cũng sẽ bị xóa. Hiệu ứng xóa sẽ hiển thị ngay lập tức và 'giá trị' sự kiện tương ứng sẽ được kích hoạt. Quá trình đồng bộ hóa quá trình xóa với máy chủ Firebase cũng sẽ được bắt đầu và Promise được trả về sẽ giải quyết khi hoàn tất. Nếu được cung cấp, lệnh gọi lại onComplete sẽ được gọi không đồng bộ sau khi quá trình đồng bộ hóa hoàn tất.
runTransaction(ref, giao dịchUpdate, tùy chọn) Sửa đổi nguyên tử dữ liệu tại vị trí này. Sửa đổi nguyên tử dữ liệu tại vị trí này. Không giống như set() thông thường, chỉ ghi đè dữ liệu bất kể giá trị trước đó của nó là gì, runTransaction() được sử dụng để sửa đổi giá trị hiện có thành giá trị mới, đảm bảo không có xung đột với các ứng dụng khách khác ghi vào cùng một vị trí cùng lúc . Để thực hiện điều này, bạn chuyển runTransaction() một hàm cập nhật được sử dụng để chuyển đổi giá trị hiện tại thành giá trị mới. Nếu một ứng dụng khách khác ghi vào vị trí trước khi giá trị mới của bạn được ghi thành công, hàm cập nhật của bạn sẽ được gọi lại với giá trị hiện tại mới và quá trình ghi sẽ được thử lại. Điều này sẽ xảy ra nhiều lần cho đến khi quá trình ghi của bạn thành công mà không có xung đột hoặc bạn hủy giao dịch do không trả về giá trị từ hàm cập nhật của mình. Lưu ý: Việc sửa đổi dữ liệu bằng set() sẽ hủy mọi giao dịch đang chờ xử lý tại vị trí đó, vì vậy cần hết sức cẩn thận nếu trộn set()runTransaction() để cập nhật cùng một dữ liệu. Lưu ý: Khi sử dụng các giao dịch có Quy tắc bảo mật và Firebase, hãy lưu ý rằng khách hàng cần có quyền truy cập .read ngoài quyền truy cập .write để thực hiện giao dịch. Điều này là do bản chất giao dịch phía khách hàng yêu cầu khách hàng đọc dữ liệu để cập nhật giao dịch.
set(ref, value) Ghi dữ liệu vào vị trí cơ sở dữ liệu này. Thao tác này sẽ ghi đè mọi dữ liệu tại vị trí này và tất cả các vị trí con. Hiệu ứng của việc ghi sẽ hiển thị ngay lập tức và các sự kiện tương ứng ("giá trị", "child_add", v.v.) sẽ được kích hoạt. Quá trình đồng bộ hóa dữ liệu với máy chủ Firebase cũng sẽ được bắt đầu và Promise được trả về sẽ giải quyết khi hoàn tất. Nếu được cung cấp, lệnh gọi lại onComplete sẽ được gọi không đồng bộ sau khi quá trình đồng bộ hóa hoàn tất. Truyền null cho giá trị mới tương đương với việc gọi remove() ; cụ thể là tất cả dữ liệu tại vị trí này và tất cả các vị trí con sẽ bị xóa. set() sẽ xóa mọi mức độ ưu tiên được lưu trữ tại vị trí này, vì vậy nếu mức độ ưu tiên được giữ nguyên, bạn cần sử dụng setWithPriority() thay thế. Lưu ý rằng việc sửa đổi dữ liệu bằng set() sẽ hủy mọi giao dịch đang chờ xử lý tại vị trí đó, vì vậy cần hết sức cẩn thận nếu trộn set()transaction() để sửa đổi cùng một dữ liệu. Một set() sẽ tạo ra một sự kiện "giá trị" duy nhất tại vị trí nơi set() được thực hiện.
setPriority(ref, mức độ ưu tiên) Đặt mức độ ưu tiên cho dữ liệu tại vị trí Cơ sở dữ liệu này. Các ứng dụng không cần sử dụng mức độ ưu tiên nhưng có thể sắp xếp các bộ sưu tập theo các thuộc tính thông thường (xem Sắp xếp và lọc dữ liệu ).
setWithPriority(ref, value, mức độ ưu tiên) Ghi dữ liệu vị trí cơ sở dữ liệu. Giống như set() nhưng cũng chỉ định mức độ ưu tiên cho dữ liệu đó. Các ứng dụng không cần sử dụng mức độ ưu tiên nhưng có thể sắp xếp các bộ sưu tập theo các thuộc tính thông thường (xem Sắp xếp và lọc dữ liệu ).
cập nhật(ref, giá trị) Ghi nhiều giá trị vào Cơ sở dữ liệu cùng một lúc. Đối values chứa nhiều cặp giá trị thuộc tính sẽ được ghi vào Cơ sở dữ liệu cùng nhau. Mỗi thuộc tính con có thể là một thuộc tính đơn giản (ví dụ: "tên") hoặc một đường dẫn tương đối (ví dụ: "tên/tên") từ vị trí hiện tại đến dữ liệu cần cập nhật. Ngược lại với phương thức set() , update() có thể được sử dụng để chỉ cập nhật có chọn lọc các thuộc tính được tham chiếu tại vị trí hiện tại (thay vì thay thế tất cả các thuộc tính con tại vị trí hiện tại). Hiệu ứng của việc ghi sẽ hiển thị ngay lập tức và các sự kiện tương ứng ('value', 'child_ Added', v.v.) sẽ được kích hoạt. Quá trình đồng bộ hóa dữ liệu với máy chủ Firebase cũng sẽ được bắt đầu và Promise được trả về sẽ giải quyết khi hoàn tất. Nếu được cung cấp, lệnh gọi lại onComplete sẽ được gọi không đồng bộ sau khi quá trình đồng bộ hóa hoàn tất. Một update() sẽ tạo ra một sự kiện "giá trị" duy nhất tại vị trí mà update() được thực hiện, bất kể có bao nhiêu phần tử con đã được sửa đổi. Lưu ý rằng việc sửa đổi dữ liệu bằng update() sẽ hủy mọi giao dịch đang chờ xử lý tại vị trí đó, vì vậy cần hết sức cẩn thận nếu trộn lẫn update()transaction() để sửa đổi cùng một dữ liệu. Truyền null tới update() sẽ xóa dữ liệu tại vị trí này. Xem Giới thiệu nội dung cập nhật ở nhiều vị trí và hơn thế nữa .
hàm(giá trị, ...)
endAt(giá trị, khóa) Tạo một QueryConstraint với điểm kết thúc được chỉ định. Việc sử dụng startAt() , startAfter() , endBefore() , endAt()equalTo() cho phép bạn chọn điểm bắt đầu và kết thúc tùy ý cho truy vấn của mình. Điểm kết thúc có tính bao gồm nên các phần tử con có giá trị chính xác được chỉ định sẽ được đưa vào truy vấn. Đối số khóa tùy chọn có thể được sử dụng để giới hạn hơn nữa phạm vi truy vấn. Nếu nó được chỉ định thì các phần tử con có chính xác giá trị được chỉ định cũng phải có tên khóa nhỏ hơn hoặc bằng khóa được chỉ định. Bạn có thể đọc thêm về endAt() trong Lọc dữ liệu .
endBefore(giá trị, khóa) Tạo một QueryConstraint với điểm kết thúc được chỉ định (độc quyền). Việc sử dụng startAt() , startAfter() , endBefore() , endAt()equalTo() cho phép bạn chọn điểm bắt đầu và kết thúc tùy ý cho truy vấn của mình. Điểm kết thúc là độc quyền. Nếu chỉ cung cấp một giá trị, các phần tử con có giá trị nhỏ hơn giá trị đã chỉ định sẽ được đưa vào truy vấn. Nếu một khóa được chỉ định thì các phần tử con phải có giá trị nhỏ hơn hoặc bằng giá trị được chỉ định và tên khóa nhỏ hơn khóa được chỉ định.
bằngTo(giá trị, khóa) Tạo một QueryConstraint bao gồm các phần tử con khớp với giá trị đã chỉ định. Việc sử dụng startAt() , startAfter() , endBefore() , endAt()equalTo() cho phép bạn chọn điểm bắt đầu và kết thúc tùy ý cho truy vấn của mình. Đối số khóa tùy chọn có thể được sử dụng để giới hạn hơn nữa phạm vi truy vấn. Nếu nó được chỉ định thì các phần tử con có chính xác giá trị được chỉ định cũng phải có chính xác khóa được chỉ định làm tên khóa của chúng. Điều này có thể được sử dụng để lọc các tập kết quả có nhiều kết quả phù hợp cho cùng một giá trị. Bạn có thể đọc thêm về equalTo() trong Lọc dữ liệu .
startAfter(giá trị, khóa) Tạo một QueryConstraint với điểm bắt đầu được chỉ định (độc quyền). Việc sử dụng startAt() , startAfter() , endBefore() , endAt()equalTo() cho phép bạn chọn điểm bắt đầu và kết thúc tùy ý cho truy vấn của mình. Điểm khởi đầu là độc quyền. Nếu chỉ cung cấp một giá trị, các phần tử con có giá trị lớn hơn giá trị đã chỉ định sẽ được đưa vào truy vấn. Nếu một khóa được chỉ định thì các phần tử con phải có giá trị lớn hơn hoặc bằng giá trị được chỉ định và tên khóa phải lớn hơn khóa được chỉ định.
startAt(giá trị, khóa) Tạo một QueryConstraint với điểm bắt đầu được chỉ định. Việc sử dụng startAt() , startAfter() , endBefore() , endAt()equalTo() cho phép bạn chọn điểm bắt đầu và kết thúc tùy ý cho truy vấn của mình. Điểm bắt đầu là bao gồm, vì vậy các phần tử con có giá trị chính xác được chỉ định sẽ được đưa vào truy vấn. Đối số khóa tùy chọn có thể được sử dụng để giới hạn hơn nữa phạm vi truy vấn. Nếu nó được chỉ định thì các phần tử con có chính xác giá trị được chỉ định cũng phải có tên khóa lớn hơn hoặc bằng khóa được chỉ định. Bạn có thể đọc thêm về startAt() trong Lọc dữ liệu .

Các lớp học

Lớp học Sự miêu tả
Cơ sở dữ liệu Lớp đại diện cho Cơ sở dữ liệu thời gian thực Firebase.
Ảnh chụp nhanh dữ liệu DataSnapshot chứa dữ liệu từ một vị trí Cơ sở dữ liệu. Bất cứ khi nào bạn đọc dữ liệu từ Cơ sở dữ liệu, bạn sẽ nhận được dữ liệu dưới dạng DataSnapshot . DataSnapshot được chuyển đến các lệnh gọi lại sự kiện mà bạn đính kèm với on() hoặc once() . Bạn có thể trích xuất nội dung của ảnh chụp nhanh dưới dạng đối tượng JavaScript bằng cách gọi phương thức val() . Ngoài ra, bạn có thể duyệt qua ảnh chụp nhanh bằng cách gọi child() để trả về các ảnh chụp nhanh con (sau đó bạn có thể gọi val() ). DataSnapshot là bản sao dữ liệu không thể thay đổi, được tạo hiệu quả tại một vị trí Cơ sở dữ liệu. Nó không thể được sửa đổi và sẽ không bao giờ thay đổi (để sửa đổi dữ liệu, bạn luôn gọi trực tiếp phương thức set() trên Reference ).
BậtNgắt kết nối Lớp onDisconnect cho phép bạn ghi hoặc xóa dữ liệu khi máy khách của bạn ngắt kết nối khỏi máy chủ Cơ sở dữ liệu. Những cập nhật này xảy ra cho dù máy khách của bạn có ngắt kết nối hoàn toàn hay không, vì vậy bạn có thể dựa vào chúng để dọn sạch dữ liệu ngay cả khi kết nối bị ngắt hoặc máy khách gặp sự cố. Lớp onDisconnect được sử dụng phổ biến nhất để quản lý sự hiện diện trong các ứng dụng hữu ích trong việc phát hiện số lượng máy khách được kết nối và khi các máy khách khác ngắt kết nối. Xem Kích hoạt khả năng ngoại tuyến trong JavaScript để biết thêm thông tin. Để tránh sự cố khi kết nối bị ngắt trước khi yêu cầu có thể được chuyển đến máy chủ Cơ sở dữ liệu, các chức năng này phải được gọi trước khi ghi bất kỳ dữ liệu nào. Lưu ý rằng hoạt động onDisconnect chỉ được kích hoạt một lần. Nếu bạn muốn một thao tác xảy ra mỗi khi xảy ra ngắt kết nối, bạn sẽ cần thiết lập lại các thao tác onDisconnect mỗi khi bạn kết nối lại.
Ràng buộc truy vấn QueryConstraint được sử dụng để thu hẹp tập tài liệu được truy vấn Cơ sở dữ liệu trả về. QueryConstraint được tạo bằng cách gọi endAt() , endBefore() , bắt đầuAt() , bắt đầuSau() , limitToFirst() , limitToLast() , orderByChild() , orderByChild() , orderByKey() , orderByPriority() , orderByValue() hoặc EqualTo() và sau đó có thể được chuyển đến query() để tạo một phiên bản truy vấn mới cũng chứa QueryConstraint này.
Kết quả giao dịch Một loại cho giá trị phân giải của runTransaction() .

Giao diện

Giao diện Sự miêu tả
Cơ sở dữ liệuTham khảo DatabaseReference đại diện cho một vị trí cụ thể trong Cơ sở dữ liệu của bạn và có thể được sử dụng để đọc hoặc ghi dữ liệu vào vị trí Cơ sở dữ liệu đó. Bạn có thể tham chiếu vị trí gốc hoặc vị trí con trong Cơ sở dữ liệu của mình bằng cách gọi ref() hoặc ref("child/path") . Việc viết được thực hiện bằng phương thức set() và việc đọc có thể được thực hiện bằng phương thức on*() . Xem https://firebase.google.com/docs/database/web/read-and-write
IteratedDataSnapshot Biểu thị ảnh chụp nhanh con của một Reference đang được lặp lại. Chìa khóa sẽ không bao giờ được xác định.
Tùy chọn nghe Một đối tượng tùy chọn có thể được sử dụng để tùy chỉnh người nghe.
Truy vấn Query sắp xếp và lọc dữ liệu tại một vị trí Cơ sở dữ liệu để chỉ bao gồm một tập hợp con dữ liệu con. Điều này có thể được sử dụng để sắp xếp việc thu thập dữ liệu theo một số thuộc tính (ví dụ: chiều cao của khủng long) cũng như để hạn chế một danh sách lớn các mục (ví dụ: tin nhắn trò chuyện) xuống một số phù hợp để đồng bộ hóa với máy khách. Các truy vấn được tạo bằng cách kết hợp một hoặc nhiều phương thức lọc được xác định ở đây với nhau. Giống như với DatabaseReference , bạn có thể nhận dữ liệu từ Query bằng cách sử dụng các phương thức on*() . Bạn sẽ chỉ nhận được các sự kiện và DataSnapshot cho tập hợp con dữ liệu phù hợp với truy vấn của bạn. Xem https://firebase.google.com/docs/database/web/lists-of-data#sorting_and_filtering_data để biết thêm thông tin.
Tham khảo có thể tham khảo Một Promise cũng có thể hoạt động như một DatabaseReference khi được trả về bởi push() . Tham chiếu có sẵn ngay lập tức và Promise sẽ được giải quyết khi quá trình ghi vào phần phụ trợ hoàn tất.
Tùy chọn giao dịch Một đối tượng tùy chọn để cấu hình các giao dịch.

Nhập bí danh

Nhập bí danh Sự miêu tả
Loại sự kiện Một trong các chuỗi sau: "value", "child_add", "child_changed", "child_removed" hoặc "child_moved".
Loại ràng buộc truy vấn Mô tả các ràng buộc truy vấn khác nhau có sẵn trong SDK này.
Hủy đăng ký Một cuộc gọi lại có thể gọi để loại bỏ người nghe.

chức năng (Ứng dụng, ...)

GetDatabase (Ứng dụng, URL)

Trả về thể hiện của SDK cơ sở dữ liệu thời gian thực được liên kết với FireBaseApp được cung cấp . Khởi tạo một thể hiện mới với các cài đặt mặc định nếu không có thể hiện tồn tại hoặc nếu phiên bản hiện tại sử dụng URL cơ sở dữ liệu tùy chỉnh.

Chữ ký:

export declare function getDatabase(app?: FirebaseApp, url?: string): Database;

Thông số

Tham số Kiểu Sự miêu tả
ứng dụng FIREBASEAPP Trường hợp FireBaseApp rằng phiên bản cơ sở dữ liệu thời gian thực được trả về được liên kết.
URL sợi dây URL của thể hiện cơ sở dữ liệu thời gian thực để kết nối với. Nếu không được cung cấp, SDK kết nối với phiên bản mặc định của ứng dụng Firebase.

Trả lại:

Cơ sở dữ liệu

Thể hiện cơ sở Database của ứng dụng được cung cấp.

chức năng (db, ...)

ConnectDatabaseEmulator (DB, Host, Port, Tùy chọn)

Sửa đổi thể hiện được cung cấp để liên lạc với trình giả lập cơ sở dữ liệu thời gian thực.

Lưu ý: Phương thức này phải được gọi trước khi thực hiện bất kỳ hoạt động nào khác.

Chữ ký:

export declare function connectDatabaseEmulator(db: Database, host: string, port: number, options?: {
    mockUserToken?: EmulatorMockTokenOptions | string;
}): void;

Thông số

Tham số Kiểu Sự miêu tả
DB Cơ sở dữ liệu Ví dụ để sửa đổi.
chủ nhà sợi dây Máy chủ giả lập (ví dụ: localhost)
Hải cảng con số Cổng giả lập (ví dụ: 8080)
tùy chọn {Mockusertoken ?: EmulatormocktokenOptions | sợi dây; }

Trả lại:

Vô hiệu

Gooffline (DB)

Ngắt kết nối với máy chủ (tất cả các hoạt động cơ sở dữ liệu sẽ được hoàn thành ngoại tuyến).

Máy khách tự động duy trì kết nối liên tục với máy chủ cơ sở dữ liệu, sẽ vẫn hoạt động vô thời hạn và kết nối lại khi bị ngắt kết nối. Tuy nhiên, các phương thức goOffline()goOnline() có thể được sử dụng để kiểm soát kết nối máy khách trong các trường hợp kết nối liên tục là không mong muốn.

Mặc dù ngoại tuyến, máy khách sẽ không còn nhận được cập nhật dữ liệu từ cơ sở dữ liệu. Tuy nhiên, tất cả các hoạt động cơ sở dữ liệu được thực hiện tại địa phương sẽ tiếp tục bắn ngay các sự kiện, cho phép ứng dụng của bạn tiếp tục hành xử bình thường. Ngoài ra, mỗi thao tác được thực hiện cục bộ sẽ tự động được xếp hàng và lấy lại khi kết nối lại với máy chủ cơ sở dữ liệu.

Để kết nối lại với cơ sở dữ liệu và bắt đầu nhận các sự kiện từ xa, xem goOnline() .

Chữ ký:

export declare function goOffline(db: Database): void;

Thông số

Tham số Kiểu Sự miêu tả
DB Cơ sở dữ liệu Ví dụ để ngắt kết nối.

Trả lại:

Vô hiệu

GoOnline (DB)

Kết nối lại với máy chủ và đồng bộ hóa trạng thái cơ sở dữ liệu ngoại tuyến với trạng thái máy chủ.

Phương thức này nên được sử dụng sau khi vô hiệu hóa kết nối hoạt động với goOffline() . Sau khi kết nối lại, máy khách sẽ truyền dữ liệu thích hợp và đốt các sự kiện thích hợp để khách hàng của bạn "bắt kịp" tự động.

Chữ ký:

export declare function goOnline(db: Database): void;

Thông số

Tham số Kiểu Sự miêu tả
DB Cơ sở dữ liệu Ví dụ để kết nối lại.

Trả lại:

Vô hiệu

Tham khảo (DB, Path)

Trả về một Reference đại diện cho vị trí trong cơ sở dữ liệu tương ứng với đường dẫn được cung cấp. Nếu không có đường dẫn nào được cung cấp, Reference sẽ trỏ đến gốc của cơ sở dữ liệu.

Chữ ký:

export declare function ref(db: Database, path?: string): DatabaseReference;

Thông số

Tham số Kiểu Sự miêu tả
DB Cơ sở dữ liệu Các thể hiện cơ sở dữ liệu để có được một tham chiếu cho.
con đường sợi dây Đường dẫn tùy chọn đại diện cho vị trí Reference trả về sẽ chỉ. Nếu không được cung cấp, Reference được trả về sẽ trỏ đến gốc của cơ sở dữ liệu.

Trả lại:

Databasereference

Nếu một đường dẫn được cung cấp, một Reference chỉ vào đường dẫn được cung cấp. Mặt khác, một Reference trỏ đến gốc của cơ sở dữ liệu.

Reffromurl (DB, URL)

Trả về một Reference đại diện cho vị trí trong cơ sở dữ liệu tương ứng với URL Firebase được cung cấp.

Một ngoại lệ được ném nếu URL không phải là URL cơ sở dữ liệu FireBase hợp lệ hoặc nó có một miền khác với trường hợp Database hiện tại.

Lưu ý rằng tất cả các tham số truy vấn ( orderBy , limitToLast , v.v.) được bỏ qua và không được áp dụng cho Reference được trả lại .

Chữ ký:

export declare function refFromURL(db: Database, url: string): DatabaseReference;

Thông số

Tham số Kiểu Sự miêu tả
DB Cơ sở dữ liệu Các thể hiện cơ sở dữ liệu để có được một tham chiếu cho.
URL sợi dây URL Firebase mà tại đó Reference trả về sẽ chỉ ra.

Trả lại:

Databasereference

Một Reference chỉ vào URL Firebase được cung cấp.

chức năng()

Tuân thủ ()

Buộc sử dụng LongPolling thay vì websockets. Điều này sẽ bị bỏ qua nếu giao thức WebSocket được sử dụng trong cơ sở dữ liệu.

Chữ ký:

export declare function forceLongPolling(): void;

Trả lại:

Vô hiệu

ForceWebsockets ()

Buộc sử dụng websockets thay vì longpolling.

Chữ ký:

export declare function forceWebSockets(): void;

Trả lại:

Vô hiệu

OrderBykey ()

Tạo một QueryConstraint mới mà đơn đặt hàng theo khóa.

Sắp xếp kết quả của một truy vấn theo các giá trị khóa (tăng dần) của chúng.

Bạn có thể đọc thêm về Dữ liệu sắp xếp của orderByKey() .

Chữ ký:

export declare function orderByKey(): QueryConstraint;

Trả lại:

QueryConstraint

OrderByPriority ()

Tạo một QueryConstraint mới mà đặt hàng theo ưu tiên.

Các ứng dụng không cần sử dụng ưu tiên nhưng có thể đặt hàng các bộ sưu tập theo các thuộc tính thông thường (xem Sắp xếp dữ liệu để thay thế cho ưu tiên.

Chữ ký:

export declare function orderByPriority(): QueryConstraint;

Trả lại:

QueryConstraint

OrderByValue ()

Tạo một QueryConstraint mới mà đơn đặt hàng theo giá trị.

Nếu trẻ em của truy vấn đều là giá trị vô hướng (chuỗi, số hoặc boolean), bạn có thể đặt hàng kết quả theo giá trị (tăng dần) của chúng.

Bạn có thể đọc thêm về Dữ liệu sắp xếp của orderByValue() .

Chữ ký:

export declare function orderByValue(): QueryConstraint;

Trả lại:

QueryConstraint

servertimeStamp ()

Trả về giá trị giữ chỗ để tự động thể hiện dấu thời gian hiện tại (thời gian kể từ thời đại unix, tính bằng mili giây) như được xác định bởi các máy chủ Firebase.

Chữ ký:

export declare function serverTimestamp(): object;

Trả lại:

sự vật

chức năng (Delta, ...)

Tăng (Delta)

Trả về giá trị giữ chỗ có thể được sử dụng để tăng về mặt nguyên tử giá trị cơ sở dữ liệu hiện tại theo Delta được cung cấp.

Chữ ký:

export declare function increment(delta: number): object;

Thông số

Tham số Kiểu Sự miêu tả
đồng bằng con số Số tiền để sửa đổi giá trị hiện tại về mặt nguyên tử.

Trả lại:

sự vật

Giá trị giữ chỗ để sửa đổi dữ liệu phía máy chủ nguyên tử.

chức năng (được bật, ...)

Enablelogging (được bật, dai dẳng)

Nhật ký gỡ lỗi thông tin vào bảng điều khiển.

Chữ ký:

export declare function enableLogging(enabled: boolean, persistent?: boolean): any;

Thông số

Tham số Kiểu Sự miêu tả
đã bật Boolean Cho phép ghi nhật ký nếu true , vô hiệu hóa đăng nhập nếu false .
kiên trì Boolean Nhớ trạng thái ghi nhật ký giữa các trang làm mới nếu true .

Trả lại:

bất kì

chức năng (giới hạn, ...)

Limittofirst (giới hạn)

Tạo ra một QueryConstraint mới rằng nếu giới hạn ở số lượng trẻ em cụ thể đầu tiên.

Phương thức limitToFirst() được sử dụng để đặt số lượng trẻ em tối đa được đồng bộ hóa cho một cuộc gọi lại nhất định. Nếu chúng tôi đặt giới hạn 100, ban đầu chúng tôi sẽ chỉ nhận được tối đa 100 sự kiện child_added . Nếu chúng tôi có ít hơn 100 tin nhắn được lưu trữ trong cơ sở dữ liệu của chúng tôi, một sự kiện child_added sẽ bắn cho mỗi tin nhắn. Tuy nhiên, nếu chúng tôi có hơn 100 tin nhắn, chúng tôi sẽ chỉ nhận được một sự kiện child_added cho 100 tin nhắn được đặt hàng đầu tiên. Khi các mục thay đổi, chúng tôi sẽ nhận được các sự kiện child_removed cho mỗi mục rơi ra khỏi danh sách hoạt động để tổng số ở mức 100.

Bạn có thể đọc thêm về limitToFirst() trong việc lọc dữ liệu .

Chữ ký:

export declare function limitToFirst(limit: number): QueryConstraint;

Thông số

Tham số Kiểu Sự miêu tả
giới hạn con số Số lượng nút tối đa để đưa vào truy vấn này.

Trả lại:

QueryConstraint

Limittolast (giới hạn)

Tạo một QueryConstraint mới được giới hạn chỉ trả lại số lượng trẻ em được chỉ định cuối cùng.

Phương thức limitToLast() được sử dụng để đặt số lượng trẻ em tối đa được đồng bộ hóa cho một cuộc gọi lại nhất định. Nếu chúng tôi đặt giới hạn 100, ban đầu chúng tôi sẽ chỉ nhận được tối đa 100 sự kiện child_added . Nếu chúng tôi có ít hơn 100 tin nhắn được lưu trữ trong cơ sở dữ liệu của chúng tôi, một sự kiện child_added sẽ bắn cho mỗi tin nhắn. Tuy nhiên, nếu chúng tôi có hơn 100 tin nhắn, chúng tôi sẽ chỉ nhận được một sự kiện child_added cho 100 tin nhắn được đặt hàng cuối cùng. Khi các mục thay đổi, chúng tôi sẽ nhận được các sự kiện child_removed cho mỗi mục rơi ra khỏi danh sách hoạt động để tổng số ở mức 100.

Bạn có thể đọc thêm về limitToLast() trong việc lọc dữ liệu .

Chữ ký:

export declare function limitToLast(limit: number): QueryConstraint;

Thông số

Tham số Kiểu Sự miêu tả
giới hạn con số Số lượng nút tối đa để đưa vào truy vấn này.

Trả lại:

QueryConstraint

hàm (logger, ...)

Enablelogging (logger)

Nhật ký gỡ lỗi thông tin vào bảng điều khiển.

Chữ ký:

export declare function enableLogging(logger: (message: string) => unknown): any;

Thông số

Tham số Kiểu Sự miêu tả
tiều phu (tin nhắn: chuỗi) => không xác định Một chức năng ghi nhật ký tùy chỉnh để kiểm soát cách mọi thứ được ghi lại.

Trả lại:

bất kì

chức năng (cha mẹ, ...)

con (cha mẹ, con đường)

Nhận một Reference cho vị trí tại đường dẫn tương đối được chỉ định.

Đường dẫn tương đối có thể là một tên con đơn giản (ví dụ: "ADA") hoặc đường dẫn được phân tách sâu hơn (ví dụ: "ADA/name/đầu tiên").

Chữ ký:

export declare function child(parent: DatabaseReference, path: string): DatabaseReference;

Thông số

Tham số Kiểu Sự miêu tả
cha mẹ Databasereference Vị trí cha mẹ.
con đường sợi dây Một con đường tương đối từ vị trí này đến vị trí con mong muốn.

Trả lại:

Databasereference

Vị trí trẻ em được chỉ định.

Đẩy (cha mẹ, giá trị)

Tạo vị trí con mới bằng cách sử dụng khóa duy nhất và trả về Reference của nó .

Đây là mẫu phổ biến nhất để thêm dữ liệu vào một tập hợp các mục.

Nếu bạn cung cấp một giá trị để push() , giá trị được ghi vào vị trí được tạo. Nếu bạn không chuyển một giá trị, không có gì được ghi vào cơ sở dữ liệu và đứa trẻ vẫn trống (nhưng bạn có thể sử dụng Reference ở nơi khác).

Các khóa duy nhất được tạo bởi push() được đặt hàng theo thời gian hiện tại, do đó, danh sách các mục kết quả được sắp xếp theo thời gian. Các phím cũng được thiết kế để không thể sử dụng được (chúng chứa 72 bit ngẫu nhiên của entropy).

Xem phần phụ vào danh sách dữ liệu . Xem các cách 2^120 để đảm bảo số nhận dạng duy nhất .

Chữ ký:

export declare function push(parent: DatabaseReference, value?: unknown): ThenableReference;

Thông số

Tham số Kiểu Sự miêu tả
cha mẹ Databasereference Vị trí cha mẹ.
giá trị không xác định Giá trị tùy chọn được viết tại vị trí được tạo.

Trả lại:

Sau đó

Promise kết hợp và Reference ; Giải quyết khi ghi hoàn tất, nhưng có thể được sử dụng ngay lập tức làm Reference đến vị trí con.

chức năng (đường dẫn, ...)

OrderBychild (Path)

Tạo một QueryConstraint mới đặt hàng theo khóa con được chỉ định.

Truy vấn chỉ có thể đặt hàng theo một khóa tại một thời điểm. Gọi orderByChild() Nhiều lần trên cùng một truy vấn là một lỗi.

Các truy vấn của Firebase cho phép bạn đặt hàng dữ liệu của mình bằng bất kỳ khóa con nào khi đang bay. Tuy nhiên, nếu bạn biết trước các chỉ mục của bạn sẽ là gì, bạn có thể xác định chúng thông qua quy tắc .indexon trong các quy tắc bảo mật của bạn để có hiệu suất tốt hơn. Xem https://firebase.google.com/docs/database/security/indexing-data quy tắc để biết thêm thông tin.

Bạn có thể đọc thêm về Dữ liệu sắp xếp của orderByChild() .

Chữ ký:

export declare function orderByChild(path: string): QueryConstraint;

Thông số

Tham số Kiểu Sự miêu tả
con đường sợi dây Con đường để đặt hàng bởi.

Trả lại:

QueryConstraint

chức năng (truy vấn, ...)

Nhận (truy vấn)

Nhận kết quả cập nhật nhất cho truy vấn này.

Chữ ký:

export declare function get(query: Query): Promise<DataSnapshot>;

Thông số

Tham số Kiểu Sự miêu tả
truy vấn Truy vấn Các truy vấn để chạy.

Trả lại:

Hứa < datasnapshot >

Một Promise sẽ giải quyết cho DataSnapShot kết quả nếu có sẵn một giá trị hoặc từ chối nếu máy khách không thể trả về giá trị (ví dụ: nếu máy chủ không thể truy cập và không có gì được lưu trong bộ nhớ cache).

TẮT (Truy vấn, EventType, Callback)

Tách một cuộc gọi lại trước đây được đính kèm với tương ứng on*() ( onValue , onChildAdded ) người nghe. Lưu ý: Đây không phải là cách được đề nghị để loại bỏ người nghe. Thay vào đó, vui lòng sử dụng chức năng gọi lại được trả về từ các cuộc gọi lại on* tương ứng.

Tháo gọi lại trước đó được đính kèm với on*() . Gọi off() trên người nghe cha sẽ không tự động xóa người nghe đã đăng ký trên các nút con, off() cũng phải được gọi trên bất kỳ người nghe con nào để xóa cuộc gọi lại.

Nếu một cuộc gọi lại không được chỉ định, tất cả các cuộc gọi lại cho EventType được chỉ định sẽ bị xóa. Tương tự, nếu không có EventType được chỉ định, tất cả các cuộc gọi lại cho Reference sẽ bị xóa.

Người nghe cá nhân cũng có thể được xóa bằng cách gọi các cuộc gọi lại hủy đăng ký của họ.

Chữ ký:

export declare function off(query: Query, eventType?: EventType, callback?: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown): void;

Thông số

Tham số Kiểu Sự miêu tả
truy vấn Truy vấn Truy vấn mà người nghe đã được đăng ký.
loại sự kiện Loại sự kiện Một trong các chuỗi sau: "Giá trị", "Child_Added", "Child_changed", "Child_Remated" hoặc "Child_Med." Nếu bị bỏ qua, tất cả các cuộc gọi lại cho Reference sẽ bị xóa.
gọi lại (Ảnh chụp nhanh: DatasNapShot , trước đó là tên ?: Chuỗi | null) => không xác định Hàm gọi lại đã được truyền đến on() hoặc undefined để xóa tất cả các cuộc gọi lại.

Trả lại:

Vô hiệu

Onchildadded (truy vấn, gọi lại, hủyCallback)

Lắng nghe thay đổi dữ liệu tại một vị trí cụ thể.

Đây là cách chính để đọc dữ liệu từ cơ sở dữ liệu. Cuộc gọi lại của bạn sẽ được kích hoạt cho dữ liệu ban đầu và một lần nữa bất cứ khi nào dữ liệu thay đổi. Gọi cuộc gọi lại hủy đăng ký lại để ngừng nhận cập nhật. Xem Truy xuất dữ liệu trên web để biết thêm chi tiết.

Một sự kiện onChildAdded sẽ được kích hoạt một lần cho mỗi đứa trẻ ban đầu tại vị trí này và nó sẽ được kích hoạt lại mỗi khi một đứa trẻ mới được thêm vào. DataSnapshot được chuyển vào cuộc gọi lại sẽ phản ánh dữ liệu cho đứa trẻ có liên quan. Đối với mục đích đặt hàng, nó được thông qua một đối số thứ hai là một chuỗi chứa khóa của đứa con anh chị em trước đó theo thứ tự sắp xếp hoặc null nếu đó là đứa trẻ đầu tiên.

Chữ ký:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

Thông số

Tham số Kiểu Sự miêu tả
truy vấn Truy vấn Các truy vấn để chạy.
gọi lại (Ảnh chụp nhanh: DatasNapShot , trước đó là tên ?: Chuỗi | null) => không xác định Một cuộc gọi lại bắn khi sự kiện được chỉ định xảy ra. Cuộc gọi lại sẽ được truyền một datasnapshot và một chuỗi chứa khóa của đứa trẻ trước, theo thứ tự sắp xếp hoặc null nếu nó là đứa trẻ đầu tiên.
Hủy bỏ trở lại (Lỗi: Lỗi) => Không xác định Một cuộc gọi lại tùy chọn sẽ được thông báo nếu đăng ký sự kiện của bạn bị hủy vì khách hàng của bạn không được phép đọc dữ liệu này (hoặc nó có sự cho phép nhưng hiện đã mất nó). Cuộc gọi lại này sẽ được thông qua một đối tượng Error cho biết lý do tại sao lỗi xảy ra.

Trả lại:

Hủy đăng ký

Một chức năng có thể được gọi để loại bỏ người nghe.

onchildadded (truy vấn, gọi lại, tùy chọn)

Lắng nghe thay đổi dữ liệu tại một vị trí cụ thể.

Đây là cách chính để đọc dữ liệu từ cơ sở dữ liệu. Cuộc gọi lại của bạn sẽ được kích hoạt cho dữ liệu ban đầu và một lần nữa bất cứ khi nào dữ liệu thay đổi. Gọi cuộc gọi lại hủy đăng ký lại để ngừng nhận cập nhật. Xem Truy xuất dữ liệu trên web để biết thêm chi tiết.

Một sự kiện onChildAdded sẽ được kích hoạt một lần cho mỗi đứa trẻ ban đầu tại vị trí này và nó sẽ được kích hoạt lại mỗi khi một đứa trẻ mới được thêm vào. DataSnapshot được chuyển vào cuộc gọi lại sẽ phản ánh dữ liệu cho đứa trẻ có liên quan. Đối với mục đích đặt hàng, nó được thông qua một đối số thứ hai là một chuỗi chứa khóa của đứa con anh chị em trước đó theo thứ tự sắp xếp hoặc null nếu đó là đứa trẻ đầu tiên.

Chữ ký:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

Thông số

Tham số Kiểu Sự miêu tả
truy vấn Truy vấn Các truy vấn để chạy.
gọi lại (Ảnh chụp nhanh: DatasNapShot , trước đó là trò chơi: Chuỗi | null) => không xác định Một cuộc gọi lại bắn khi sự kiện được chỉ định xảy ra. Cuộc gọi lại sẽ được truyền một datasnapshot và một chuỗi chứa khóa của đứa trẻ trước, theo thứ tự sắp xếp hoặc null nếu nó là đứa trẻ đầu tiên.
tùy chọn Lắng nghe Một đối tượng có thể được sử dụng để định cấu onlyOnce , sau đó loại bỏ người nghe sau khi gọi đầu tiên.

Trả lại:

Hủy đăng ký

Một chức năng có thể được gọi để loại bỏ người nghe.

Onchildadded (truy vấn, gọi lại, hủyCallback, Tùy chọn)

Lắng nghe thay đổi dữ liệu tại một vị trí cụ thể.

Đây là cách chính để đọc dữ liệu từ cơ sở dữ liệu. Cuộc gọi lại của bạn sẽ được kích hoạt cho dữ liệu ban đầu và một lần nữa bất cứ khi nào dữ liệu thay đổi. Gọi cuộc gọi lại hủy đăng ký lại để ngừng nhận cập nhật. Xem Truy xuất dữ liệu trên web để biết thêm chi tiết.

Một sự kiện onChildAdded sẽ được kích hoạt một lần cho mỗi đứa trẻ ban đầu tại vị trí này và nó sẽ được kích hoạt lại mỗi khi một đứa trẻ mới được thêm vào. DataSnapshot được chuyển vào cuộc gọi lại sẽ phản ánh dữ liệu cho đứa trẻ có liên quan. Đối với mục đích đặt hàng, nó được thông qua một đối số thứ hai là một chuỗi chứa khóa của đứa con anh chị em trước đó theo thứ tự sắp xếp hoặc null nếu đó là đứa trẻ đầu tiên.

Chữ ký:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

Thông số

Tham số Kiểu Sự miêu tả
truy vấn Truy vấn Các truy vấn để chạy.
gọi lại (Ảnh chụp nhanh: DatasNapShot , trước đó là trò chơi: Chuỗi | null) => không xác định Một cuộc gọi lại bắn khi sự kiện được chỉ định xảy ra. Cuộc gọi lại sẽ được truyền một datasnapshot và một chuỗi chứa khóa của đứa trẻ trước, theo thứ tự sắp xếp hoặc null nếu nó là đứa trẻ đầu tiên.
Hủy bỏ trở lại (Lỗi: Lỗi) => Không xác định Một cuộc gọi lại tùy chọn sẽ được thông báo nếu đăng ký sự kiện của bạn bị hủy vì khách hàng của bạn không được phép đọc dữ liệu này (hoặc nó có sự cho phép nhưng hiện đã mất nó). Cuộc gọi lại này sẽ được thông qua một đối tượng Error cho biết lý do tại sao lỗi xảy ra.
tùy chọn Lắng nghe Một đối tượng có thể được sử dụng để định cấu onlyOnce , sau đó loại bỏ người nghe sau khi gọi đầu tiên.

Trả lại:

Hủy đăng ký

Một chức năng có thể được gọi để loại bỏ người nghe.

OnchildChanged (truy vấn, gọi lại, hủyCallback)

Lắng nghe thay đổi dữ liệu tại một vị trí cụ thể.

Đây là cách chính để đọc dữ liệu từ cơ sở dữ liệu. Cuộc gọi lại của bạn sẽ được kích hoạt cho dữ liệu ban đầu và một lần nữa bất cứ khi nào dữ liệu thay đổi. Gọi cuộc gọi lại hủy đăng ký lại để ngừng nhận cập nhật. Xem Truy xuất dữ liệu trên web để biết thêm chi tiết.

Một sự kiện onChildChanged sẽ được kích hoạt khi dữ liệu được lưu trữ ở một đứa trẻ (hoặc bất kỳ con cháu nào của nó) thay đổi. Lưu ý rằng một sự kiện child_changed có thể đại diện cho nhiều thay đổi cho trẻ. DataSnapshot được chuyển cho cuộc gọi lại sẽ chứa nội dung trẻ mới. Đối với mục đích đặt hàng, cuộc gọi lại cũng được thông qua đối số thứ hai là một chuỗi chứa khóa của đứa con anh chị em trước đó theo thứ tự sắp xếp hoặc null nếu đó là đứa con đầu lòng.

Chữ ký:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

Thông số

Tham số Kiểu Sự miêu tả
truy vấn Truy vấn Các truy vấn để chạy.
gọi lại (Ảnh chụp nhanh: DatasNapShot , trước đó là trò chơi: Chuỗi | null) => không xác định Một cuộc gọi lại bắn khi sự kiện được chỉ định xảy ra. Cuộc gọi lại sẽ được truyền một datasnapshot và một chuỗi chứa khóa của đứa trẻ trước, theo thứ tự sắp xếp hoặc null nếu nó là đứa trẻ đầu tiên.
Hủy bỏ trở lại (Lỗi: Lỗi) => Không xác định Một cuộc gọi lại tùy chọn sẽ được thông báo nếu đăng ký sự kiện của bạn bị hủy vì khách hàng của bạn không được phép đọc dữ liệu này (hoặc nó có sự cho phép nhưng hiện đã mất nó). Cuộc gọi lại này sẽ được thông qua một đối tượng Error cho biết lý do tại sao lỗi xảy ra.

Trả lại:

Hủy đăng ký

Một chức năng có thể được gọi để loại bỏ người nghe.

onchildchanged (truy vấn, gọi lại, tùy chọn)

Lắng nghe thay đổi dữ liệu tại một vị trí cụ thể.

Đây là cách chính để đọc dữ liệu từ cơ sở dữ liệu. Cuộc gọi lại của bạn sẽ được kích hoạt cho dữ liệu ban đầu và một lần nữa bất cứ khi nào dữ liệu thay đổi. Gọi cuộc gọi lại hủy đăng ký lại để ngừng nhận cập nhật. Xem Truy xuất dữ liệu trên web để biết thêm chi tiết.

Một sự kiện onChildChanged sẽ được kích hoạt khi dữ liệu được lưu trữ ở một đứa trẻ (hoặc bất kỳ con cháu nào của nó) thay đổi. Lưu ý rằng một sự kiện child_changed có thể đại diện cho nhiều thay đổi cho trẻ. DataSnapshot được chuyển cho cuộc gọi lại sẽ chứa nội dung trẻ mới. Đối với mục đích đặt hàng, cuộc gọi lại cũng được thông qua đối số thứ hai là một chuỗi chứa khóa của đứa con anh chị em trước đó theo thứ tự sắp xếp hoặc null nếu đó là đứa con đầu lòng.

Chữ ký:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

Thông số

Tham số Kiểu Sự miêu tả
truy vấn Truy vấn Các truy vấn để chạy.
gọi lại (Ảnh chụp nhanh: DatasNapShot , trước đó là trò chơi: Chuỗi | null) => không xác định Một cuộc gọi lại bắn khi sự kiện được chỉ định xảy ra. Cuộc gọi lại sẽ được truyền một datasnapshot và một chuỗi chứa khóa của đứa trẻ trước, theo thứ tự sắp xếp hoặc null nếu nó là đứa trẻ đầu tiên.
tùy chọn Lắng nghe Một đối tượng có thể được sử dụng để định cấu onlyOnce , sau đó loại bỏ người nghe sau khi gọi đầu tiên.

Trả lại:

Hủy đăng ký

Một chức năng có thể được gọi để loại bỏ người nghe.

OnchildChanged (truy vấn, gọi lại, hủyCallback, Tùy chọn)

Lắng nghe thay đổi dữ liệu tại một vị trí cụ thể.

Đây là cách chính để đọc dữ liệu từ cơ sở dữ liệu. Cuộc gọi lại của bạn sẽ được kích hoạt cho dữ liệu ban đầu và một lần nữa bất cứ khi nào dữ liệu thay đổi. Gọi cuộc gọi lại hủy đăng ký lại để ngừng nhận cập nhật. Xem Truy xuất dữ liệu trên web để biết thêm chi tiết.

Một sự kiện onChildChanged sẽ được kích hoạt khi dữ liệu được lưu trữ ở một đứa trẻ (hoặc bất kỳ con cháu nào của nó) thay đổi. Lưu ý rằng một sự kiện child_changed có thể đại diện cho nhiều thay đổi cho trẻ. DataSnapshot được chuyển cho cuộc gọi lại sẽ chứa nội dung trẻ mới. Đối với mục đích đặt hàng, cuộc gọi lại cũng được thông qua đối số thứ hai là một chuỗi chứa khóa của đứa con anh chị em trước đó theo thứ tự sắp xếp hoặc null nếu đó là đứa con đầu lòng.

Chữ ký:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

Thông số

Tham số Kiểu Sự miêu tả
truy vấn Truy vấn Các truy vấn để chạy.
gọi lại (Ảnh chụp nhanh: DatasNapShot , trước đó là trò chơi: Chuỗi | null) => không xác định Một cuộc gọi lại bắn khi sự kiện được chỉ định xảy ra. Cuộc gọi lại sẽ được truyền một datasnapshot và một chuỗi chứa khóa của đứa trẻ trước, theo thứ tự sắp xếp hoặc null nếu nó là đứa trẻ đầu tiên.
Hủy bỏ trở lại (Lỗi: Lỗi) => Không xác định Một cuộc gọi lại tùy chọn sẽ được thông báo nếu đăng ký sự kiện của bạn bị hủy vì khách hàng của bạn không được phép đọc dữ liệu này (hoặc nó có sự cho phép nhưng hiện đã mất nó). Cuộc gọi lại này sẽ được thông qua một đối tượng Error cho biết lý do tại sao lỗi xảy ra.
tùy chọn Lắng nghe Một đối tượng có thể được sử dụng để định cấu onlyOnce , sau đó loại bỏ người nghe sau khi gọi đầu tiên.

Trả lại:

Hủy đăng ký

Một chức năng có thể được gọi để loại bỏ người nghe.

OnChildMed (truy vấn, gọi lại, hủyCallback)

Lắng nghe thay đổi dữ liệu tại một vị trí cụ thể.

Đây là cách chính để đọc dữ liệu từ cơ sở dữ liệu. Cuộc gọi lại của bạn sẽ được kích hoạt cho dữ liệu ban đầu và một lần nữa bất cứ khi nào dữ liệu thay đổi. Gọi cuộc gọi lại hủy đăng ký lại để ngừng nhận cập nhật. Xem Truy xuất dữ liệu trên web để biết thêm chi tiết.

Một sự kiện onChildMoved sẽ được kích hoạt khi thứ tự sắp xếp của trẻ thay đổi sao cho vị trí của nó so với anh chị em của nó thay đổi. DataSnapshot được chuyển cho cuộc gọi lại sẽ dành cho dữ liệu của đứa trẻ đã di chuyển. Nó cũng được thông qua một đối số thứ hai là một chuỗi chứa khóa của đứa con anh chị em trước đó theo thứ tự sắp xếp, hoặc null nếu đó là đứa con đầu tiên.

Chữ ký:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

Thông số

Tham số Kiểu Sự miêu tả
truy vấn Truy vấn Các truy vấn để chạy.
gọi lại (Ảnh chụp nhanh: DatasNapShot , trước đó là trò chơi: Chuỗi | null) => không xác định Một cuộc gọi lại bắn khi sự kiện được chỉ định xảy ra. Cuộc gọi lại sẽ được truyền một datasnapshot và một chuỗi chứa khóa của đứa trẻ trước, theo thứ tự sắp xếp hoặc null nếu nó là đứa trẻ đầu tiên.
Hủy bỏ trở lại (Lỗi: Lỗi) => Không xác định Một cuộc gọi lại tùy chọn sẽ được thông báo nếu đăng ký sự kiện của bạn bị hủy vì khách hàng của bạn không được phép đọc dữ liệu này (hoặc nó có sự cho phép nhưng hiện đã mất nó). Cuộc gọi lại này sẽ được thông qua một đối tượng Error cho biết lý do tại sao lỗi xảy ra.

Trả lại:

Hủy đăng ký

Một chức năng có thể được gọi để loại bỏ người nghe.

Onchildmed (truy vấn, gọi lại, tùy chọn)

Lắng nghe thay đổi dữ liệu tại một vị trí cụ thể.

Đây là cách chính để đọc dữ liệu từ cơ sở dữ liệu. Cuộc gọi lại của bạn sẽ được kích hoạt cho dữ liệu ban đầu và một lần nữa bất cứ khi nào dữ liệu thay đổi. Gọi cuộc gọi lại hủy đăng ký lại để ngừng nhận cập nhật. Xem Truy xuất dữ liệu trên web để biết thêm chi tiết.

Một sự kiện onChildMoved sẽ được kích hoạt khi thứ tự sắp xếp của trẻ thay đổi sao cho vị trí của nó so với anh chị em của nó thay đổi. DataSnapshot được chuyển cho cuộc gọi lại sẽ dành cho dữ liệu của đứa trẻ đã di chuyển. Nó cũng được thông qua một đối số thứ hai là một chuỗi chứa khóa của đứa con anh chị em trước đó theo thứ tự sắp xếp, hoặc null nếu đó là đứa con đầu tiên.

Chữ ký:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

Thông số

Tham số Kiểu Sự miêu tả
truy vấn Truy vấn Các truy vấn để chạy.
gọi lại (Ảnh chụp nhanh: DatasNapShot , trước đó là trò chơi: Chuỗi | null) => không xác định Một cuộc gọi lại bắn khi sự kiện được chỉ định xảy ra. Cuộc gọi lại sẽ được truyền một datasnapshot và một chuỗi chứa khóa của đứa trẻ trước, theo thứ tự sắp xếp hoặc null nếu nó là đứa trẻ đầu tiên.
tùy chọn Lắng nghe Một đối tượng có thể được sử dụng để định cấu onlyOnce , sau đó loại bỏ người nghe sau khi gọi đầu tiên.

Trả lại:

Hủy đăng ký

Một chức năng có thể được gọi để loại bỏ người nghe.

OnChildMove (truy vấn, gọi lại, hủyCallback, Tùy chọn)

Lắng nghe thay đổi dữ liệu tại một vị trí cụ thể.

Đây là cách chính để đọc dữ liệu từ cơ sở dữ liệu. Cuộc gọi lại của bạn sẽ được kích hoạt cho dữ liệu ban đầu và một lần nữa bất cứ khi nào dữ liệu thay đổi. Gọi cuộc gọi lại hủy đăng ký lại để ngừng nhận cập nhật. Xem Truy xuất dữ liệu trên web để biết thêm chi tiết.

Một sự kiện onChildMoved sẽ được kích hoạt khi thứ tự sắp xếp của trẻ thay đổi sao cho vị trí của nó so với anh chị em của nó thay đổi. DataSnapshot được chuyển cho cuộc gọi lại sẽ dành cho dữ liệu của đứa trẻ đã di chuyển. Nó cũng được thông qua một đối số thứ hai là một chuỗi chứa khóa của đứa con anh chị em trước đó theo thứ tự sắp xếp, hoặc null nếu đó là đứa con đầu tiên.

Chữ ký:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

Thông số

Tham số Kiểu Sự miêu tả
truy vấn Truy vấn Các truy vấn để chạy.
gọi lại (Ảnh chụp nhanh: DatasNapShot , trước đó là trò chơi: Chuỗi | null) => không xác định Một cuộc gọi lại bắn khi sự kiện được chỉ định xảy ra. Cuộc gọi lại sẽ được truyền một datasnapshot và một chuỗi chứa khóa của đứa trẻ trước, theo thứ tự sắp xếp hoặc null nếu nó là đứa trẻ đầu tiên.
Hủy bỏ trở lại (Lỗi: Lỗi) => Không xác định Một cuộc gọi lại tùy chọn sẽ được thông báo nếu đăng ký sự kiện của bạn bị hủy vì khách hàng của bạn không được phép đọc dữ liệu này (hoặc nó có sự cho phép nhưng hiện đã mất nó). Cuộc gọi lại này sẽ được thông qua một đối tượng Error cho biết lý do tại sao lỗi xảy ra.
tùy chọn Lắng nghe Một đối tượng có thể được sử dụng để định cấu onlyOnce , sau đó loại bỏ người nghe sau khi gọi đầu tiên.

Trả lại:

Hủy đăng ký

Một chức năng có thể được gọi để loại bỏ người nghe.

OnchildRemove (truy vấn, gọi lại, hủyCallback)

Lắng nghe thay đổi dữ liệu tại một vị trí cụ thể.

Đây là cách chính để đọc dữ liệu từ cơ sở dữ liệu. Cuộc gọi lại của bạn sẽ được kích hoạt cho dữ liệu ban đầu và một lần nữa bất cứ khi nào dữ liệu thay đổi. Gọi cuộc gọi lại hủy đăng ký lại để ngừng nhận cập nhật. Xem Truy xuất dữ liệu trên web để biết thêm chi tiết.

Một sự kiện onChildRemoved sẽ được kích hoạt một lần mỗi khi một đứa trẻ bị loại bỏ. DataSnapshot được chuyển vào cuộc gọi lại sẽ là dữ liệu cũ cho đứa trẻ đã bị xóa. Một đứa trẻ sẽ bị loại bỏ khi một trong hai:

  • Một khách hàng gọi rõ ràng remove() trên đứa trẻ đó hoặc một trong những tổ tiên của nó - một khách hàng gọi set(null) trên đứa trẻ đó hoặc một trong những đứa trẻ đó đã bị xóa tất cả trẻ em - có một truy vấn có hiệu lực hiện đang lọc ra khỏi trẻ (vì nó đã thay đổi thứ tự sắp xếp hoặc giới hạn tối đa đã bị ảnh hưởng)

Chữ ký:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

Thông số

Tham số Kiểu Sự miêu tả
truy vấn Truy vấn Các truy vấn để chạy.
gọi lại (Ảnh chụp nhanh: DatasNapShot ) => Không xác định Một cuộc gọi lại bắn khi sự kiện được chỉ định xảy ra. Cuộc gọi lại sẽ được truyền một datasnapshot và một chuỗi chứa khóa của đứa trẻ trước, theo thứ tự sắp xếp hoặc null nếu nó là đứa trẻ đầu tiên.
Hủy bỏ trở lại (Lỗi: Lỗi) => Không xác định Một cuộc gọi lại tùy chọn sẽ được thông báo nếu đăng ký sự kiện của bạn bị hủy vì khách hàng của bạn không được phép đọc dữ liệu này (hoặc nó có sự cho phép nhưng hiện đã mất nó). Cuộc gọi lại này sẽ được thông qua một đối tượng Error cho biết lý do tại sao lỗi xảy ra.

Trả lại:

Hủy đăng ký

Một chức năng có thể được gọi để loại bỏ người nghe.

Onchildremove (truy vấn, gọi lại, tùy chọn)

Lắng nghe thay đổi dữ liệu tại một vị trí cụ thể.

Đây là cách chính để đọc dữ liệu từ cơ sở dữ liệu. Cuộc gọi lại của bạn sẽ được kích hoạt cho dữ liệu ban đầu và một lần nữa bất cứ khi nào dữ liệu thay đổi. Gọi cuộc gọi lại hủy đăng ký lại để ngừng nhận cập nhật. Xem Truy xuất dữ liệu trên web để biết thêm chi tiết.

Một sự kiện onChildRemoved sẽ được kích hoạt một lần mỗi khi một đứa trẻ bị loại bỏ. DataSnapshot được chuyển vào cuộc gọi lại sẽ là dữ liệu cũ cho đứa trẻ đã bị xóa. Một đứa trẻ sẽ bị loại bỏ khi một trong hai:

  • Một khách hàng gọi rõ ràng remove() trên đứa trẻ đó hoặc một trong những tổ tiên của nó - một khách hàng gọi set(null) trên đứa trẻ đó hoặc một trong những đứa trẻ đó đã bị xóa tất cả trẻ em - có một truy vấn có hiệu lực hiện đang lọc ra khỏi trẻ (vì nó đã thay đổi thứ tự sắp xếp hoặc giới hạn tối đa đã bị ảnh hưởng)

Chữ ký:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;

Thông số

Tham số Kiểu Sự miêu tả
truy vấn Truy vấn Các truy vấn để chạy.
gọi lại (Ảnh chụp nhanh: DatasNapShot ) => Không xác định Một cuộc gọi lại bắn khi sự kiện được chỉ định xảy ra. Cuộc gọi lại sẽ được truyền một datasnapshot và một chuỗi chứa khóa của đứa trẻ trước, theo thứ tự sắp xếp hoặc null nếu nó là đứa trẻ đầu tiên.
tùy chọn Lắng nghe Một đối tượng có thể được sử dụng để định cấu onlyOnce , sau đó loại bỏ người nghe sau khi gọi đầu tiên.

Trả lại:

Hủy đăng ký

Một chức năng có thể được gọi để loại bỏ người nghe.

OnchildRemove (truy vấn, gọi lại, hủyCallback, Tùy chọn)

Lắng nghe thay đổi dữ liệu tại một vị trí cụ thể.

Đây là cách chính để đọc dữ liệu từ cơ sở dữ liệu. Cuộc gọi lại của bạn sẽ được kích hoạt cho dữ liệu ban đầu và một lần nữa bất cứ khi nào dữ liệu thay đổi. Gọi cuộc gọi lại hủy đăng ký lại để ngừng nhận cập nhật. Xem Truy xuất dữ liệu trên web để biết thêm chi tiết.

Một sự kiện onChildRemoved sẽ được kích hoạt một lần mỗi khi một đứa trẻ bị loại bỏ. DataSnapshot được chuyển vào cuộc gọi lại sẽ là dữ liệu cũ cho đứa trẻ đã bị xóa. Một đứa trẻ sẽ bị loại bỏ khi một trong hai:

  • Một khách hàng gọi rõ ràng remove() trên đứa trẻ đó hoặc một trong những tổ tiên của nó - một khách hàng gọi set(null) trên đứa trẻ đó hoặc một trong những đứa trẻ đó đã bị xóa tất cả trẻ em - có một truy vấn có hiệu lực hiện đang lọc ra khỏi trẻ (vì nó đã thay đổi thứ tự sắp xếp hoặc giới hạn tối đa đã bị ảnh hưởng)

Chữ ký:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

Thông số

Tham số Kiểu Sự miêu tả
truy vấn Truy vấn Các truy vấn để chạy.
gọi lại (Ảnh chụp nhanh: DatasNapShot ) => Không xác định Một cuộc gọi lại bắn khi sự kiện được chỉ định xảy ra. Cuộc gọi lại sẽ được truyền một datasnapshot và một chuỗi chứa khóa của đứa trẻ trước, theo thứ tự sắp xếp hoặc null nếu nó là đứa trẻ đầu tiên.
Hủy bỏ trở lại (Lỗi: Lỗi) => Không xác định Một cuộc gọi lại tùy chọn sẽ được thông báo nếu đăng ký sự kiện của bạn bị hủy vì khách hàng của bạn không được phép đọc dữ liệu này (hoặc nó có sự cho phép nhưng hiện đã mất nó). Cuộc gọi lại này sẽ được thông qua một đối tượng Error cho biết lý do tại sao lỗi xảy ra.
tùy chọn Lắng nghe Một đối tượng có thể được sử dụng để định cấu onlyOnce , sau đó loại bỏ người nghe sau khi gọi đầu tiên.

Trả lại:

Hủy đăng ký

Một chức năng có thể được gọi để loại bỏ người nghe.

OnValue (truy vấn, gọi lại, hủyCallback)

Lắng nghe thay đổi dữ liệu tại một vị trí cụ thể.

Đây là cách chính để đọc dữ liệu từ cơ sở dữ liệu. Cuộc gọi lại của bạn sẽ được kích hoạt cho dữ liệu ban đầu và một lần nữa bất cứ khi nào dữ liệu thay đổi. Gọi cuộc gọi lại hủy đăng ký lại để ngừng nhận cập nhật. Xem Truy xuất dữ liệu trên web để biết thêm chi tiết.

Một sự kiện onValue sẽ kích hoạt một lần với dữ liệu ban đầu được lưu trữ tại vị trí này và sau đó kích hoạt lại mỗi khi dữ liệu thay đổi. DataSnapshot được chuyển cho cuộc gọi lại sẽ dành cho vị trí mà on() được gọi. Nó sẽ không kích hoạt cho đến khi toàn bộ nội dung được đồng bộ hóa. Nếu vị trí không có dữ liệu, nó sẽ được kích hoạt với một DataSnapshot ( val() sẽ trả về null ).

Chữ ký:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

Thông số

Tham số Kiểu Sự miêu tả
truy vấn Truy vấn Các truy vấn để chạy.
gọi lại (Ảnh chụp nhanh: DatasNapShot ) => Không xác định Một cuộc gọi lại bắn khi sự kiện được chỉ định xảy ra. Cuộc gọi lại sẽ được thông qua một datasnapshot.
Hủy bỏ trở lại (Lỗi: Lỗi) => Không xác định Một cuộc gọi lại tùy chọn sẽ được thông báo nếu đăng ký sự kiện của bạn bị hủy vì khách hàng của bạn không được phép đọc dữ liệu này (hoặc nó có sự cho phép nhưng hiện đã mất nó). Cuộc gọi lại này sẽ được thông qua một đối tượng Error cho biết lý do tại sao lỗi xảy ra.

Trả lại:

Hủy đăng ký

Một chức năng có thể được gọi để loại bỏ người nghe.

OnValue (truy vấn, gọi lại, tùy chọn)

Lắng nghe thay đổi dữ liệu tại một vị trí cụ thể.

Đây là cách chính để đọc dữ liệu từ cơ sở dữ liệu. Cuộc gọi lại của bạn sẽ được kích hoạt cho dữ liệu ban đầu và một lần nữa bất cứ khi nào dữ liệu thay đổi. Gọi cuộc gọi lại hủy đăng ký lại để ngừng nhận cập nhật. Xem Truy xuất dữ liệu trên web để biết thêm chi tiết.

Một sự kiện onValue sẽ kích hoạt một lần với dữ liệu ban đầu được lưu trữ tại vị trí này và sau đó kích hoạt lại mỗi khi dữ liệu thay đổi. DataSnapshot được chuyển cho cuộc gọi lại sẽ dành cho vị trí mà on() được gọi. Nó sẽ không kích hoạt cho đến khi toàn bộ nội dung được đồng bộ hóa. Nếu vị trí không có dữ liệu, nó sẽ được kích hoạt với một DataSnapshot ( val() sẽ trả về null ).

Chữ ký:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;

Thông số

Tham số Kiểu Sự miêu tả
truy vấn Truy vấn Các truy vấn để chạy.
gọi lại (Ảnh chụp nhanh: DatasNapShot ) => Không xác định Một cuộc gọi lại bắn khi sự kiện được chỉ định xảy ra. Cuộc gọi lại sẽ được thông qua một datasnapshot.
tùy chọn Lắng nghe Một đối tượng có thể được sử dụng để định cấu onlyOnce , sau đó loại bỏ người nghe sau khi gọi đầu tiên.

Trả lại:

Hủy đăng ký

Một chức năng có thể được gọi để loại bỏ người nghe.

OnValue (truy vấn, gọi lại, hủyCallback, Tùy chọn)

Lắng nghe thay đổi dữ liệu tại một vị trí cụ thể.

Đây là cách chính để đọc dữ liệu từ cơ sở dữ liệu. Cuộc gọi lại của bạn sẽ được kích hoạt cho dữ liệu ban đầu và một lần nữa bất cứ khi nào dữ liệu thay đổi. Gọi cuộc gọi lại hủy đăng ký lại để ngừng nhận cập nhật. Xem Truy xuất dữ liệu trên web để biết thêm chi tiết.

Một sự kiện onValue sẽ kích hoạt một lần với dữ liệu ban đầu được lưu trữ tại vị trí này và sau đó kích hoạt lại mỗi khi dữ liệu thay đổi. DataSnapshot được chuyển cho cuộc gọi lại sẽ dành cho vị trí mà on() được gọi. Nó sẽ không kích hoạt cho đến khi toàn bộ nội dung được đồng bộ hóa. Nếu vị trí không có dữ liệu, nó sẽ được kích hoạt với một DataSnapshot ( val() sẽ trả về null ).

Chữ ký:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

Thông số

Tham số Kiểu Sự miêu tả
truy vấn Truy vấn Các truy vấn để chạy.
gọi lại (Ảnh chụp nhanh: DatasNapShot ) => Không xác định Một cuộc gọi lại bắn khi sự kiện được chỉ định xảy ra. Cuộc gọi lại sẽ được thông qua một datasnapshot.
Hủy bỏ trở lại (Lỗi: Lỗi) => Không xác định Một cuộc gọi lại tùy chọn sẽ được thông báo nếu đăng ký sự kiện của bạn bị hủy vì khách hàng của bạn không được phép đọc dữ liệu này (hoặc nó có sự cho phép nhưng hiện đã mất nó). Cuộc gọi lại này sẽ được thông qua một đối tượng Error cho biết lý do tại sao lỗi xảy ra.
tùy chọn Lắng nghe Một đối tượng có thể được sử dụng để định cấu onlyOnce , sau đó loại bỏ người nghe sau khi gọi đầu tiên.

Trả lại:

Hủy đăng ký

A function that can be invoked to remove the listener.

query(query, queryConstraints)

Creates a new immutable instance of Query that is extended to also include additional query constraints.

Chữ ký:

export declare function query(query: Query, ...queryConstraints: QueryConstraint[]): Query;

Thông số

Tham số Kiểu Sự miêu tả
truy vấn Truy vấn The Query instance to use as a base for the new constraints.
queryConstraints QueryConstraint [] The list of QueryConstraint s to apply.

Returns:

Truy vấn

Ngoại lệ

if any of the provided query constraints cannot be combined with the existing or new constraints.

function(ref, ...)

onDisconnect(ref)

Returns an OnDisconnect object - see Enabling Offline Capabilities in JavaScript for more information on how to use it.

Chữ ký:

export declare function onDisconnect(ref: DatabaseReference): OnDisconnect;

Thông số

Tham số Kiểu Sự miêu tả
giới thiệu DatabaseReference The reference to add OnDisconnect triggers for.

Returns:

OnDisconnect

remove(ref)

Removes the data at this Database location.

Any data at child locations will also be deleted.

The effect of the remove will be visible immediately and the corresponding event 'value' will be triggered. Synchronization of the remove to the Firebase servers will also be started, and the returned Promise will resolve when complete. If provided, the onComplete callback will be called asynchronously after synchronization has finished.

Chữ ký:

export declare function remove(ref: DatabaseReference): Promise<void>;

Thông số

Tham số Kiểu Sự miêu tả
giới thiệu DatabaseReference The location to remove.

Returns:

Promise<void>

Resolves when remove on server is complete.

runTransaction(ref, transactionUpdate, options)

Atomically modifies the data at this location.

Atomically modify the data at this location. Unlike a normal set() , which just overwrites the data regardless of its previous value, runTransaction() is used to modify the existing value to a new value, ensuring there are no conflicts with other clients writing to the same location at the same time.

To accomplish this, you pass runTransaction() an update function which is used to transform the current value into a new value. If another client writes to the location before your new value is successfully written, your update function will be called again with the new current value, and the write will be retried. This will happen repeatedly until your write succeeds without conflict or you abort the transaction by not returning a value from your update function.

Chữ ký:

export declare function runTransaction(ref: DatabaseReference, transactionUpdate: (currentData: any) => unknown, options?: TransactionOptions): Promise<TransactionResult>;

Thông số

Tham số Kiểu Sự miêu tả
giới thiệu DatabaseReference The location to atomically modify.
transactionUpdate (currentData: any) => unknown A developer-supplied function which will be passed the current data stored at this location (as a JavaScript object). The function should return the new value it would like written (as a JavaScript object). If undefined is returned (ie you return with no arguments) the transaction will be aborted and the data at this location will not be modified.
tùy chọn TransactionOptions An options object to configure transactions.

Returns:

Promise< TransactionResult >

A Promise that can optionally be used instead of the onComplete callback to handle success and failure.

set(ref, value)

Writes data to this Database location.

This will overwrite any data at this location and all child locations.

The effect of the write will be visible immediately, and the corresponding events ("value", "child_added", etc.) will be triggered. Synchronization of the data to the Firebase servers will also be started, and the returned Promise will resolve when complete. If provided, the onComplete callback will be called asynchronously after synchronization has finished.

Passing null for the new value is equivalent to calling remove() ; namely, all data at this location and all child locations will be deleted.

set() will remove any priority stored at this location, so if priority is meant to be preserved, you need to use setWithPriority() instead.

Note that modifying data with set() will cancel any pending transactions at that location, so extreme care should be taken if mixing set() and transaction() to modify the same data.

A single set() will generate a single "value" event at the location where the set() was performed.

Chữ ký:

export declare function set(ref: DatabaseReference, value: unknown): Promise<void>;

Thông số

Tham số Kiểu Sự miêu tả
giới thiệu DatabaseReference The location to write to.
giá trị không xác định The value to be written (string, number, boolean, object, array, or null).

Returns:

Promise<void>

Resolves when write to server is complete.

setPriority(ref, priority)

Sets a priority for the data at this Database location.

Applications need not use priority but can order collections by ordinary properties (see Sorting and filtering data ).

Chữ ký:

export declare function setPriority(ref: DatabaseReference, priority: string | number | null): Promise<void>;

Thông số

Tham số Kiểu Sự miêu tả
giới thiệu DatabaseReference The location to write to.
sự ưu tiên string | number | vô giá trị The priority to be written (string, number, or null).

Returns:

Promise<void>

Resolves when write to server is complete.

setWithPriority(ref, value, priority)

Writes data the Database location. Like set() but also specifies the priority for that data.

Applications need not use priority but can order collections by ordinary properties (see Sorting and filtering data ).

Chữ ký:

export declare function setWithPriority(ref: DatabaseReference, value: unknown, priority: string | number | null): Promise<void>;

Thông số

Tham số Kiểu Sự miêu tả
giới thiệu DatabaseReference The location to write to.
giá trị không xác định The value to be written (string, number, boolean, object, array, or null).
sự ưu tiên string | number | vô giá trị The priority to be written (string, number, or null).

Returns:

Promise<void>

Resolves when write to server is complete.

update(ref, values)

Writes multiple values to the Database at once.

The values argument contains multiple property-value pairs that will be written to the Database together. Each child property can either be a simple property (for example, "name") or a relative path (for example, "name/first") from the current location to the data to update.

As opposed to the set() method, update() can be use to selectively update only the referenced properties at the current location (instead of replacing all the child properties at the current location).

The effect of the write will be visible immediately, and the corresponding events ('value', 'child_added', etc.) will be triggered. Synchronization of the data to the Firebase servers will also be started, and the returned Promise will resolve when complete. If provided, the onComplete callback will be called asynchronously after synchronization has finished.

A single update() will generate a single "value" event at the location where the update() was performed, regardless of how many children were modified.

Note that modifying data with update() will cancel any pending transactions at that location, so extreme care should be taken if mixing update() and transaction() to modify the same data.

Passing null to update() will remove the data at this location.

See Introducing multi-location updates and more .

Chữ ký:

export declare function update(ref: DatabaseReference, values: object): Promise<void>;

Thông số

Tham số Kiểu Sự miêu tả
giới thiệu DatabaseReference The location to write to.
values sự vật Object containing multiple values.

Returns:

Promise<void>

Resolves when update on server is complete.

function(value, ...)

endAt(value, key)

Creates a QueryConstraint with the specified ending point.

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The ending point is inclusive, so children with exactly the specified value will be included in the query. The optional key argument can be used to further limit the range of the query. If it is specified, then children that have exactly the specified value must also have a key name less than or equal to the specified key.

You can read more about endAt() in Filtering data .

Chữ ký:

export declare function endAt(value: number | string | boolean | null, key?: string): QueryConstraint;

Thông số

Tham số Kiểu Sự miêu tả
giá trị number | string | boolean | vô giá trị The value to end at. The argument type depends on which orderBy () function was used in this query. Specify a value that matches the orderBy () type. When used in combination with orderByKey() , the value must be a string.
chìa khóa sợi dây The child key to end at, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.

Returns:

QueryConstraint

endBefore(value, key)

Creates a QueryConstraint with the specified ending point (exclusive).

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The ending point is exclusive. If only a value is provided, children with a value less than the specified value will be included in the query. If a key is specified, then children must have a value less than or equal to the specified value and a key name less than the specified key.

Chữ ký:

export declare function endBefore(value: number | string | boolean | null, key?: string): QueryConstraint;

Thông số

Tham số Kiểu Sự miêu tả
giá trị number | string | boolean | vô giá trị The value to end before. The argument type depends on which orderBy () function was used in this query. Specify a value that matches the orderBy () type. When used in combination with orderByKey() , the value must be a string.
chìa khóa sợi dây The child key to end before, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.

Returns:

QueryConstraint

equalTo(value, key)

Creates a QueryConstraint that includes children that match the specified value.

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The optional key argument can be used to further limit the range of the query. If it is specified, then children that have exactly the specified value must also have exactly the specified key as their key name. This can be used to filter result sets with many matches for the same value.

You can read more about equalTo() in Filtering data .

Chữ ký:

export declare function equalTo(value: number | string | boolean | null, key?: string): QueryConstraint;

Thông số

Tham số Kiểu Sự miêu tả
giá trị number | string | boolean | vô giá trị The value to match for. The argument type depends on which orderBy () function was used in this query. Specify a value that matches the orderBy () type. When used in combination with orderByKey() , the value must be a string.
chìa khóa sợi dây The child key to start at, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.

Returns:

QueryConstraint

startAfter(value, key)

Creates a QueryConstraint with the specified starting point (exclusive).

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The starting point is exclusive. If only a value is provided, children with a value greater than the specified value will be included in the query. If a key is specified, then children must have a value greater than or equal to the specified value and aa key name greater than the specified key.

Chữ ký:

export declare function startAfter(value: number | string | boolean | null, key?: string): QueryConstraint;

Thông số

Tham số Kiểu Sự miêu tả
giá trị number | string | boolean | vô giá trị The value to start after. The argument type depends on which orderBy () function was used in this query. Specify a value that matches the orderBy () type. When used in combination with orderByKey() , the value must be a string.
chìa khóa sợi dây The child key to start after. This argument is only allowed if ordering by child, value, or priority.

Returns:

QueryConstraint

startAt(value, key)

Creates a QueryConstraint with the specified starting point.

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The starting point is inclusive, so children with exactly the specified value will be included in the query. The optional key argument can be used to further limit the range of the query. If it is specified, then children that have exactly the specified value must also have a key name greater than or equal to the specified key.

You can read more about startAt() in Filtering data .

Chữ ký:

export declare function startAt(value?: number | string | boolean | null, key?: string): QueryConstraint;

Thông số

Tham số Kiểu Sự miêu tả
giá trị number | string | boolean | vô giá trị The value to start at. The argument type depends on which orderBy () function was used in this query. Specify a value that matches the orderBy () type. When used in combination with orderByKey() , the value must be a string.
chìa khóa sợi dây The child key to start at. This argument is only allowed if ordering by child, value, or priority.

Returns:

QueryConstraint

Loại sự kiện

One of the following strings: "value", "child_added", "child_changed", "child_removed", or "child_moved."

Chữ ký:

export declare type EventType = 'value' | 'child_added' | 'child_changed' | 'child_moved' | 'child_removed';

QueryConstraintType

Describes the different query constraints available in this SDK.

Chữ ký:

export declare type QueryConstraintType = 'endAt' | 'endBefore' | 'startAt' | 'startAfter' | 'limitToFirst' | 'limitToLast' | 'orderByChild' | 'orderByKey' | 'orderByPriority' | 'orderByValue' | 'equalTo';

Hủy đăng ký

A callback that can invoked to remove a listener.

Chữ ký:

export declare type Unsubscribe = () => void;