firestore

Documentation

Index

• Constants
• 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) List(ctx context.Context, collection string, params *Params, queries []*Query) ([]*firestore.DocumentSnapshot, error)
  • func (f *Firestore) Search(ctx context.Context, collection string, params *Params, value string) ([]*firestore.DocumentSnapshot, error)
  • func (f *Firestore) Set(ctx context.Context, collection string, document string, data interface{}) error
• type Params
• type Query

Constants

const (
	OrderByAsc  = "asc"  // 昇順
	OrderByDesc = "desc" // 降順
)

ソート順

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) List

func (f *Firestore) List(
	ctx context.Context, collection string, params *Params, queries []*Query,
) ([]*firestore.DocumentSnapshot, error)

List - コレクション内のドキュメントを福数取得

func (*Firestore) Search

func (f *Firestore) Search(
	ctx context.Context, collection string, params *Params, value string,
) ([]*firestore.DocumentSnapshot, error)

Search - 前方一致検索

func (*Firestore) Set

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

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

type Params

type Params struct {
	Offset     string
	Limit      int
	OrderField string
	OrderBy    string
}

Params - Where()メソッドで使用するクエリ構造体

type Query

type Query struct {
	Field    string
	Operator string // <, <=, >, >=, ==, !=, array-contains, array-contains-any, in, not-int
	Value    interface{}
}

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