CINXE.COM

<!DOCTYPE html> <html lang="en"><head><script type="text/javascript" src="https://www.googletagmanager.com/gtm.js?id=GTM-MX6DBN9" async="async"></script><script type="text/javascript" src="/static/hash-o6oemknr/js/gtm.js"></script><meta charset="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no"/><meta name="generator" content="made with love by dartdoc"/><meta name="description" content="cloud_firestore API docs, for the Dart programming language."/><title>cloud_firestore - Dart API docs</title><link rel="canonical" href="https://pub.dev/documentation/cloud_firestore/latest/"/><link rel="preconnect" href="https://fonts.gstatic.com"/><link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap"/><link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@24,400,0,0"/><link rel="stylesheet" href="/static/hash-o6oemknr/css/dartdoc.css"/><link rel="icon" href="/favicon.ico?hash=nk4nss8c7444fg0chird9erqef2vkhb8"/></head><body class="light-theme" data-base-href="" data-using-base-href="false"><noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MX6DBN9" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript><div id="overlay-under-drawer"></div><header id="title"><span id="sidenav-left-toggle" class="material-symbols-outlined" role="button" tabindex="0">menu</span><a class="hidden-xs" href="/"><img src="/static/hash-o6oemknr/img/dart-logo.svg" alt="" width="30" height="30" role="presentation" style="height: 30px; margin-right: 1em;"/></a><ol class="breadcrumbs gt-separated dark hidden-xs"><li><a href="/packages/cloud_firestore">cloud_firestore package</a></li><li class="self-crumb">documentation</li></ol><div class="self-name">cloud_firestore package</div><form class="search navbar-right" role="search"><input id="search-box" class="form-control typeahead" type="text" placeholder="Loading search..." autocomplete="off"/></form><div id="theme-button" class="toggle" title="Toggle brightness"><label for="theme"><input id="theme" type="checkbox" value="light-theme"/><span id="dark-theme-button" class="material-symbols-outlined">dark_mode</span><span id="light-theme-button" class="material-symbols-outlined">light_mode</span></label></div></header><main><div id="dartdoc-main-content" class="main-content"> <div class="desc markdown markdown-body"> <p><a href="https://flutter.dev/docs/development/packages-and-plugins/favorites" rel="ugc"><img src="https://raw.githubusercontent.com/firebase/flutterfire/main/.github/images/flutter_favorite.png" width="200"></a></p> <h1 id="cloud-firestore-plugin-for-flutter">Cloud Firestore Plugin for Flutter</h1> <p>A Flutter plugin to use the <a href="https://firebase.google.com/docs/firestore/" rel="ugc nofollow">Cloud Firestore API</a>.</p> <p>To learn more about Firebase Cloud Firestore, please visit the <a href="https://firebase.google.com/products/firestore" rel="ugc nofollow">Firebase website</a></p> <p><a href="https://pub.dev/packages/cloud_firestore" rel="ugc"><img src="https://img.shields.io/pub/v/cloud_firestore.svg" alt="pub package"></a></p> <h2 id="getting-started">Getting Started</h2> <p>To get started with Cloud Firestore for Flutter, please <a href="https://firebase.google.com/docs/firestore/quickstart" rel="ugc nofollow">see the documentation</a>.</p> <h2 id="usage">Usage</h2> <p>To use this plugin, please visit the <a href="https://firebase.google.com/docs/firestore/manage-data/add-data" rel="ugc nofollow">Firestore Usage documentation</a></p> <h2 id="issues-and-feedback">Issues and feedback</h2> <p>Please file FlutterFire specific issues, bugs, or feature requests in our <a href="https://github.com/firebase/flutterfire/issues/new" rel="ugc nofollow">issue tracker</a>.</p> <p>Plugin issues that are not specific to FlutterFire can be filed in the <a href="https://github.com/flutter/flutter/issues/new" rel="ugc nofollow">Flutter issue tracker</a>.</p> <p>To contribute a change to this plugin, please review our <a href="https://github.com/firebase/flutterfire/blob/main/CONTRIBUTING.md" rel="ugc nofollow">contribution guide</a> and open a <a href="https://github.com/firebase/flutterfire/pulls" rel="ugc nofollow">pull request</a>.</p> </div> <div class="summary"> <h2>Libraries</h2> <dl> <dt id="cloud_firestore"> <span class="name"><a href="cloud_firestore/cloud_firestore-library.html">cloud_firestore</a></span> </dt> <dd> </dd> </dl> </div> </div><div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left"><header id="header-search-sidebar" class="hidden-l"><form class="search-sidebar" role="search"><input id="search-sidebar" class="form-control typeahead" type="text" placeholder="Loading search..." autocomplete="off"/></form></header><ol id="sidebar-nav" class="breadcrumbs gt-separated dark hidden-l"><li><a href="/packages/cloud_firestore">cloud_firestore package</a></li><li class="self-crumb">documentation</li></ol>  <h5 class="hidden-xs"><span class="package-name">cloud_firestore</span> <span class="package-kind">package</span></h5> <ol> <li class="section-title">Libraries</li> <li><a href="cloud_firestore/cloud_firestore-library.html">cloud_firestore</a></li> </ol> <div id="dartdoc-sidebar-left-content"></div></div><div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right"> </div></main><footer><span class="no-break">cloud_firestore 5.5.0</span></footer><script src="/static/hash-o6oemknr/dartdoc/resources/highlight.pack.js"></script><script src="/static/hash-o6oemknr/dartdoc/resources/docs.dart.js"></script></body></html>