Documentation ¶
Index ¶
- Constants
- Variables
- type Firestore
- type FirestoreItem
- type FirestoreItemsCollectionRef
- func (ref *FirestoreItemsCollectionRef) Create(ctx context.Context, p *Item) (*firestore.WriteResult, error)
- func (ref *FirestoreItemsCollectionRef) Doc(id string) *FirestoreItemsDocumentRef
- func (ref *FirestoreItemsCollectionRef) Limit(n int) *FirestoreItemsQuery
- func (ref *FirestoreItemsCollectionRef) OrderBy(path string, dir firestore.Direction) *FirestoreItemsQuery
- func (ref *FirestoreItemsCollectionRef) Where(path, op string, value interface{}) *FirestoreItemsQuery
- type FirestoreItemsDocumentRef
- func (ref *FirestoreItemsDocumentRef) Delete(ctx context.Context, preconds ...firestore.Precondition) (*firestore.WriteResult, error)
- func (ref *FirestoreItemsDocumentRef) Get(ctx context.Context) (*Item, error)
- func (ref *FirestoreItemsDocumentRef) Ref() *firestore.DocumentRef
- func (ref *FirestoreItemsDocumentRef) Set(ctx context.Context, msg *Item, opts ...firestore.SetOption) error
- type FirestoreItemsIterator
- func (i *FirestoreItemsIterator) GetAll() ([]*Item, error)
- func (i *FirestoreItemsIterator) GetAllAsSnapshots() ([]*firestore.DocumentSnapshot, error)
- func (i *FirestoreItemsIterator) Next() (*Item, error)
- func (i *FirestoreItemsIterator) NextAsSnapshot() (*firestore.DocumentSnapshot, error)
- func (i *FirestoreItemsIterator) Stop()
- type FirestoreItemsQuery
- func (q *FirestoreItemsQuery) Documents(ctx context.Context) *FirestoreItemsIterator
- func (q *FirestoreItemsQuery) First(ctx context.Context) (*Item, error)
- func (q *FirestoreItemsQuery) Limit(n int) *FirestoreItemsQuery
- func (q *FirestoreItemsQuery) OrderBy(path string, dir firestore.Direction) *FirestoreItemsQuery
- func (q *FirestoreItemsQuery) Value() firestore.Query
- func (q *FirestoreItemsQuery) Where(path, op string, value interface{}) *FirestoreItemsQuery
- type FirestoreParentsCollectionRef
- func (ref *FirestoreParentsCollectionRef) Doc(id string) *FirestoreParentsDocumentRef
- func (ref *FirestoreParentsCollectionRef) Limit(n int) *FirestoreParentsQuery
- func (ref *FirestoreParentsCollectionRef) OrderBy(path string, dir firestore.Direction) *FirestoreParentsQuery
- func (ref *FirestoreParentsCollectionRef) Where(path, op string, value interface{}) *FirestoreParentsQuery
- type FirestoreParentsDocumentRef
- type FirestoreParentsIterator
- type FirestoreParentsQuery
- func (q *FirestoreParentsQuery) Documents(ctx context.Context) *FirestoreParentsIterator
- func (q *FirestoreParentsQuery) Limit(n int) *FirestoreParentsQuery
- func (q *FirestoreParentsQuery) OrderBy(path string, dir firestore.Direction) *FirestoreParentsQuery
- func (q *FirestoreParentsQuery) Value() firestore.Query
- func (q *FirestoreParentsQuery) Where(path, op string, value interface{}) *FirestoreParentsQuery
- type FirestoreSubparentsCollectionRef
- func (ref *FirestoreSubparentsCollectionRef) Doc(id string) *FirestoreSubparentsDocumentRef
- func (ref *FirestoreSubparentsCollectionRef) Limit(n int) *FirestoreSubparentsQuery
- func (ref *FirestoreSubparentsCollectionRef) OrderBy(path string, dir firestore.Direction) *FirestoreSubparentsQuery
- func (ref *FirestoreSubparentsCollectionRef) Where(path, op string, value interface{}) *FirestoreSubparentsQuery
- type FirestoreSubparentsDocumentRef
- type FirestoreSubparentsIterator
- type FirestoreSubparentsQuery
- func (q *FirestoreSubparentsQuery) Documents(ctx context.Context) *FirestoreSubparentsIterator
- func (q *FirestoreSubparentsQuery) Limit(n int) *FirestoreSubparentsQuery
- func (q *FirestoreSubparentsQuery) OrderBy(path string, dir firestore.Direction) *FirestoreSubparentsQuery
- func (q *FirestoreSubparentsQuery) Value() firestore.Query
- func (q *FirestoreSubparentsQuery) Where(path, op string, value interface{}) *FirestoreSubparentsQuery
- type Item
Constants ¶
const FirestoreCollectionItems = "items"
FirestoreCollectionItems is the Firestore collection name for documents of type unlinked.Item.
Variables ¶
var File_unlinked_unlinked_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Firestore ¶
type Firestore struct {
// contains filtered or unexported fields
}
func WithFirestore ¶
func (*Firestore) Parents ¶
func (fs *Firestore) Parents() *FirestoreParentsCollectionRef
type FirestoreItem ¶
type FirestoreItem struct {
Name string `firestore:"name,omitempty"`
}
FirestoreItem is the Firestore Custom Object for unlinked.Item.
func (*FirestoreItem) ToProto ¶
func (m *FirestoreItem) ToProto() (*Item, error)
ToProto converts this FirestoreItem to its protobuf representation.
type FirestoreItemsCollectionRef ¶
type FirestoreItemsCollectionRef struct {
// contains filtered or unexported fields
}
FirestoreItemsCollectionRef holds a reference to the Firestore collection `items`.
func (*FirestoreItemsCollectionRef) Create ¶
func (ref *FirestoreItemsCollectionRef) Create(ctx context.Context, p *Item) (*firestore.WriteResult, error)
func (*FirestoreItemsCollectionRef) Doc ¶
func (ref *FirestoreItemsCollectionRef) Doc(id string) *FirestoreItemsDocumentRef
func (*FirestoreItemsCollectionRef) Limit ¶
func (ref *FirestoreItemsCollectionRef) Limit(n int) *FirestoreItemsQuery
func (*FirestoreItemsCollectionRef) OrderBy ¶
func (ref *FirestoreItemsCollectionRef) OrderBy(path string, dir firestore.Direction) *FirestoreItemsQuery
func (*FirestoreItemsCollectionRef) Where ¶
func (ref *FirestoreItemsCollectionRef) Where(path, op string, value interface{}) *FirestoreItemsQuery
type FirestoreItemsDocumentRef ¶
type FirestoreItemsDocumentRef struct {
// contains filtered or unexported fields
}
FirestoreItemsDocumentRef holds a reference to a Firestore document in collection `items`.
func (*FirestoreItemsDocumentRef) Delete ¶
func (ref *FirestoreItemsDocumentRef) Delete(ctx context.Context, preconds ...firestore.Precondition) (*firestore.WriteResult, error)
func (*FirestoreItemsDocumentRef) Get ¶
func (ref *FirestoreItemsDocumentRef) Get(ctx context.Context) (*Item, error)
func (*FirestoreItemsDocumentRef) Ref ¶
func (ref *FirestoreItemsDocumentRef) Ref() *firestore.DocumentRef
type FirestoreItemsIterator ¶
type FirestoreItemsIterator struct {
// contains filtered or unexported fields
}
func (*FirestoreItemsIterator) GetAll ¶
func (i *FirestoreItemsIterator) GetAll() ([]*Item, error)
func (*FirestoreItemsIterator) GetAllAsSnapshots ¶
func (i *FirestoreItemsIterator) GetAllAsSnapshots() ([]*firestore.DocumentSnapshot, error)
func (*FirestoreItemsIterator) Next ¶
func (i *FirestoreItemsIterator) Next() (*Item, error)
func (*FirestoreItemsIterator) NextAsSnapshot ¶
func (i *FirestoreItemsIterator) NextAsSnapshot() (*firestore.DocumentSnapshot, error)
func (*FirestoreItemsIterator) Stop ¶
func (i *FirestoreItemsIterator) Stop()
type FirestoreItemsQuery ¶
type FirestoreItemsQuery struct {
// contains filtered or unexported fields
}
func (*FirestoreItemsQuery) Documents ¶
func (q *FirestoreItemsQuery) Documents(ctx context.Context) *FirestoreItemsIterator
func (*FirestoreItemsQuery) First ¶
func (q *FirestoreItemsQuery) First(ctx context.Context) (*Item, error)
func (*FirestoreItemsQuery) Limit ¶
func (q *FirestoreItemsQuery) Limit(n int) *FirestoreItemsQuery
func (*FirestoreItemsQuery) OrderBy ¶
func (q *FirestoreItemsQuery) OrderBy(path string, dir firestore.Direction) *FirestoreItemsQuery
func (*FirestoreItemsQuery) Value ¶
func (q *FirestoreItemsQuery) Value() firestore.Query
func (*FirestoreItemsQuery) Where ¶
func (q *FirestoreItemsQuery) Where(path, op string, value interface{}) *FirestoreItemsQuery
type FirestoreParentsCollectionRef ¶
type FirestoreParentsCollectionRef struct {
// contains filtered or unexported fields
}
FirestoreParentsCollectionRef holds a reference to the Firestore collection `parents`.
func (*FirestoreParentsCollectionRef) Doc ¶
func (ref *FirestoreParentsCollectionRef) Doc(id string) *FirestoreParentsDocumentRef
func (*FirestoreParentsCollectionRef) Limit ¶
func (ref *FirestoreParentsCollectionRef) Limit(n int) *FirestoreParentsQuery
func (*FirestoreParentsCollectionRef) OrderBy ¶
func (ref *FirestoreParentsCollectionRef) OrderBy(path string, dir firestore.Direction) *FirestoreParentsQuery
func (*FirestoreParentsCollectionRef) Where ¶
func (ref *FirestoreParentsCollectionRef) Where(path, op string, value interface{}) *FirestoreParentsQuery
type FirestoreParentsDocumentRef ¶
type FirestoreParentsDocumentRef struct {
// contains filtered or unexported fields
}
FirestoreParentsDocumentRef holds a reference to a Firestore document in collection `parents`.
func (*FirestoreParentsDocumentRef) Subparents ¶ added in v2.0.2
func (ref *FirestoreParentsDocumentRef) Subparents() *FirestoreSubparentsCollectionRef
type FirestoreParentsIterator ¶
type FirestoreParentsIterator struct {
// contains filtered or unexported fields
}
func (*FirestoreParentsIterator) Stop ¶
func (i *FirestoreParentsIterator) Stop()
type FirestoreParentsQuery ¶
type FirestoreParentsQuery struct {
// contains filtered or unexported fields
}
func (*FirestoreParentsQuery) Documents ¶
func (q *FirestoreParentsQuery) Documents(ctx context.Context) *FirestoreParentsIterator
func (*FirestoreParentsQuery) Limit ¶
func (q *FirestoreParentsQuery) Limit(n int) *FirestoreParentsQuery
func (*FirestoreParentsQuery) OrderBy ¶
func (q *FirestoreParentsQuery) OrderBy(path string, dir firestore.Direction) *FirestoreParentsQuery
func (*FirestoreParentsQuery) Value ¶
func (q *FirestoreParentsQuery) Value() firestore.Query
func (*FirestoreParentsQuery) Where ¶
func (q *FirestoreParentsQuery) Where(path, op string, value interface{}) *FirestoreParentsQuery
type FirestoreSubparentsCollectionRef ¶
type FirestoreSubparentsCollectionRef struct {
// contains filtered or unexported fields
}
FirestoreSubparentsCollectionRef holds a reference to the Firestore collection `subparents`.
func (*FirestoreSubparentsCollectionRef) Doc ¶
func (ref *FirestoreSubparentsCollectionRef) Doc(id string) *FirestoreSubparentsDocumentRef
func (*FirestoreSubparentsCollectionRef) Limit ¶
func (ref *FirestoreSubparentsCollectionRef) Limit(n int) *FirestoreSubparentsQuery
func (*FirestoreSubparentsCollectionRef) OrderBy ¶
func (ref *FirestoreSubparentsCollectionRef) OrderBy(path string, dir firestore.Direction) *FirestoreSubparentsQuery
func (*FirestoreSubparentsCollectionRef) Where ¶
func (ref *FirestoreSubparentsCollectionRef) Where(path, op string, value interface{}) *FirestoreSubparentsQuery
type FirestoreSubparentsDocumentRef ¶
type FirestoreSubparentsDocumentRef struct {
// contains filtered or unexported fields
}
FirestoreSubparentsDocumentRef holds a reference to a Firestore document in collection `subparents`.
func (*FirestoreSubparentsDocumentRef) Items ¶ added in v2.0.2
func (ref *FirestoreSubparentsDocumentRef) Items() *FirestoreItemsCollectionRef
type FirestoreSubparentsIterator ¶
type FirestoreSubparentsIterator struct {
// contains filtered or unexported fields
}
func (*FirestoreSubparentsIterator) Stop ¶
func (i *FirestoreSubparentsIterator) Stop()
type FirestoreSubparentsQuery ¶
type FirestoreSubparentsQuery struct {
// contains filtered or unexported fields
}
func (*FirestoreSubparentsQuery) Documents ¶
func (q *FirestoreSubparentsQuery) Documents(ctx context.Context) *FirestoreSubparentsIterator
func (*FirestoreSubparentsQuery) Limit ¶
func (q *FirestoreSubparentsQuery) Limit(n int) *FirestoreSubparentsQuery
func (*FirestoreSubparentsQuery) OrderBy ¶
func (q *FirestoreSubparentsQuery) OrderBy(path string, dir firestore.Direction) *FirestoreSubparentsQuery
func (*FirestoreSubparentsQuery) Value ¶
func (q *FirestoreSubparentsQuery) Value() firestore.Query
func (*FirestoreSubparentsQuery) Where ¶
func (q *FirestoreSubparentsQuery) Where(path, op string, value interface{}) *FirestoreSubparentsQuery
type Item ¶
type Item struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // contains filtered or unexported fields }
func (*Item) Descriptor
deprecated
func (*Item) ProtoMessage ¶
func (*Item) ProtoMessage()
func (*Item) ProtoReflect ¶
func (x *Item) ProtoReflect() protoreflect.Message
func (*Item) ToFirestore ¶
func (x *Item) ToFirestore() (*FirestoreItem, error)
ToFirestore returns the Firestore Custom Object for Item.