cloudfirestore

Documentation

Index

• func AddStartWith(q firestore.Query, key string, word string) firestore.Query
• func CommitWriteBatch(ctx context.Context) (context.Context, error)
• func Create(ctx context.Context, colRef *firestore.CollectionRef, src interface{}) error
• func Delete(ctx context.Context, docRef *firestore.DocumentRef) error
• func GenerateDocumentRef(client *firestore.Client, docRefs []*DocRef) *firestore.DocumentRef
• func Get(ctx context.Context, docRef *firestore.DocumentRef, dst interface{}) (bool, error)
• func GetByQuery(ctx context.Context, query firestore.Query, dst interface{}) (bool, error)
• func GetMulti(ctx context.Context, client *firestore.Client, ...) error
• func ListByQuery(ctx context.Context, query firestore.Query, dsts interface{}) error
• func ListByQueryCursor(ctx context.Context, query firestore.Query, limit int, ...) (*firestore.DocumentSnapshot, error)
• func NewClient(projectID string) *firestore.Client
• func RunTransaction(ctx context.Context, client *firestore.Client, ...) error
• func RunWriteBatch(ctx context.Context, client *firestore.Client) context.Context
• func Set(ctx context.Context, docRef *firestore.DocumentRef, src interface{}) error
• func Update(ctx context.Context, docRef *firestore.DocumentRef, kv map[string]interface{}) error
• type DocRef
• type SummaryDocRef
  • func GenerateSummaryDocRef(docRef *firestore.DocumentRef, rootCollectionPath string) *SummaryDocRef

Functions

func AddStartWith

func AddStartWith(q firestore.Query, key string, word string) firestore.Query

AddStartWith ... 前方一致クエリを追加する

func CommitWriteBatch

func CommitWriteBatch(ctx context.Context) (context.Context, error)

func Create

func Create(ctx context.Context, colRef *firestore.CollectionRef, src interface{}) error

Create ... 作成する(tx, bt対応)

func Delete

func Delete(ctx context.Context, docRef *firestore.DocumentRef) error

Delete ... 削除する(tx, bt対応)

func GenerateDocumentRef

func GenerateDocumentRef(client *firestore.Client, docRefs []*DocRef) *firestore.DocumentRef

GenerateDocumentRef ... ドキュメント参照を作成する

func Get

func Get(ctx context.Context, docRef *firestore.DocumentRef, dst interface{}) (bool, error)

Get ... 単体取得する(tx対応)

func GetByQuery

func GetByQuery(ctx context.Context, query firestore.Query, dst interface{}) (bool, error)

GetByQuery ... クエリで単体取得する(tx対応)

func GetMulti

func GetMulti(ctx context.Context, client *firestore.Client, docRefs []*firestore.DocumentRef, dsts interface{}) error

GetMulti ... 複数取得する(tx対応)

func ListByQuery

func ListByQuery(ctx context.Context, query firestore.Query, dsts interface{}) error

ListByQuery ... クエリで複数取得する

func ListByQueryCursor

func ListByQueryCursor(ctx context.Context, query firestore.Query, limit int, cursor *firestore.DocumentSnapshot, dsts interface{}) (*firestore.DocumentSnapshot, error)

ListByQueryCursor ... クエリで複数取得する（ページング）

func NewClient

func NewClient(projectID string) *firestore.Client

NewClient ... Firestoreのクライアントを取得する

func RunTransaction

func RunTransaction(ctx context.Context, client *firestore.Client, fn func(ctx context.Context) error, opts ...firestore.TransactionOption) error

func RunWriteBatch

func RunWriteBatch(ctx context.Context, client *firestore.Client) context.Context

func Set

func Set(ctx context.Context, docRef *firestore.DocumentRef, src interface{}) error

Set ... 上書きする(tx, bt対応)

func Update

func Update(ctx context.Context, docRef *firestore.DocumentRef, kv map[string]interface{}) error

Update ... 更新する(tx, bt対応)

Types

type DocRef

type DocRef struct {
	CollectionName string `json:"collection_name"`
	DocID          string `json:"doc_id"`
}

DocRef ... 個別のドキュメント参照

type SummaryDocRef

type SummaryDocRef struct {
	ID   string `json:"id"`
	Path string `json:"path"`
}

SummaryDocRef ... 最小のドキュメント参照(フロントに返せる)

func GenerateSummaryDocRef

func GenerateSummaryDocRef(docRef *firestore.DocumentRef, rootCollectionPath string) *SummaryDocRef

GenerateSummaryDocRef ... 最小のドキュメント参照を取得する