firestore

Documentation

Index

• type Firestore
  • func NewClient(ctx context.Context, app *firebase.App) (*Firestore, error)
  • func (f *Firestore) Close() error
  • func (f *Firestore) DeleteDoc(ctx context.Context, collection string, document string) error
  • func (f *Firestore) Get(ctx context.Context, collection string, document string) (*firestore.DocumentSnapshot, error)
  • func (f *Firestore) GetAll(ctx context.Context, collection string) *firestore.DocumentIterator
  • func (f *Firestore) GetAllFirst(ctx context.Context, collection string, orderBy string, sort string, ...) ([]*firestore.DocumentSnapshot, error)
  • func (f *Firestore) GetAllFromStartAt(ctx context.Context, collection string, orderBy string, sort string, ...) ([]*firestore.DocumentSnapshot, error)
  • func (f *Firestore) GetByQueries(ctx context.Context, collection string, queries []*Query) *firestore.DocumentIterator
  • func (f *Firestore) GetByQuery(ctx context.Context, collection string, query *Query) *firestore.DocumentIterator
  • func (f *Firestore) Search(ctx context.Context, collection string, orderBy string, sort string, ...) ([]*firestore.DocumentSnapshot, error)
  • func (f *Firestore) SearchFromStartAt(ctx context.Context, collection string, orderBy string, sort string, ...) ([]*firestore.DocumentSnapshot, error)
  • func (f *Firestore) Set(ctx context.Context, collection string, document string, data interface{}) error
• type Query

Types

type Firestore

type Firestore struct {
	Client *firestore.Client
}

Firestore - Firestoreの構造体

func NewClient

func NewClient(ctx context.Context, app *firebase.App) (*Firestore, error)

NewClient - Firestoreに接続

func (*Firestore) Close

func (f *Firestore) Close() error

Close - Firestoreとの接続を終了

func (*Firestore) DeleteDoc

func (f *Firestore) DeleteDoc(ctx context.Context, collection string, document string) error

DeleteDoc - ドキュメントを削除

func (*Firestore) Get

func (f *Firestore) Get(ctx context.Context, collection string, document string) (*firestore.DocumentSnapshot, error)

Get - 単一のドキュメントの内容を取得

func (*Firestore) GetAll

func (f *Firestore) GetAll(ctx context.Context, collection string) *firestore.DocumentIterator

GetAll - コレクション内のすべてのドキュメントを取得

func (*Firestore) GetAllFirst

func (f *Firestore) GetAllFirst(
	ctx context.Context, collection string, orderBy string, sort string, length int,
) ([]*firestore.DocumentSnapshot, error)

GetAllFirst - 初めから指定の件数分ドキュメントを取得

func (*Firestore) GetAllFromStartAt

func (f *Firestore) GetAllFromStartAt(
	ctx context.Context, collection string, orderBy string, sort string, document string, length int,
) ([]*firestore.DocumentSnapshot, error)

GetAllFromStartAt - 指定した箇所から指定の件数分ドキュメントを取得

func (*Firestore) GetByQueries

func (f *Firestore) GetByQueries(ctx context.Context, collection string, queries []*Query) *firestore.DocumentIterator

GetByQueries - 複数のwhere()メソッドをつなぎ合わせて、特定の条件を満たすすべてのドキュメントを取得

func (*Firestore) GetByQuery

func (f *Firestore) GetByQuery(ctx context.Context, collection string, query *Query) *firestore.DocumentIterator

GetByQuery - where()を使用して、特定の条件を満たすすべてのドキュメントを取得

func (*Firestore) Search

func (f *Firestore) Search(
	ctx context.Context, collection string, orderBy string, sort string, query string, length int,
) ([]*firestore.DocumentSnapshot, error)

Search - 前方一致検索

func (*Firestore) SearchFromStartAt

func (f *Firestore) SearchFromStartAt(
	ctx context.Context, collection string, orderBy string, sort string, query string, document string, length int,
) ([]*firestore.DocumentSnapshot, error)

SearchFromStartAt - ()指定した箇所から)前方一致検索

func (*Firestore) Set

func (f *Firestore) Set(ctx context.Context, collection string, document string, data interface{}) error

Set - 単一のドキュメントを作成または上書き

type Query

type Query struct {
	Field    string
	Operator string // <、<=、==、>、>=
	Value    interface{}
}

Query - Where()メソッドのフィルタリング使用するクエリ構造体