firestore

Jan 2, 2025

Changes in this version

+ func WithCommitResponseTo(r *CommitResponse) commitResponse

+ type CommitResponse struct

+ func (r *CommitResponse) CommitTime() time.Time

type Update

+ func (u Update) String() string

Sep 11, 2024

Changes in this version

+ func Ptr[T any](t T) *T

type AggregationQuery

+ func (a *AggregationQuery) GetResponse(ctx context.Context) (aro *AggregationResponse, err error)

+ type AggregationResponse struct

+ ExplainMetrics *ExplainMetrics

+ Result AggregationResult

type DocumentIterator

+ func (it *DocumentIterator) ExplainMetrics() (*ExplainMetrics, error)

+ type ExecutionStats struct

+ DebugStats *map[string]any

+ ExecutionDuration *time.Duration

+ ReadOperations int64

+ ResultsReturned int64

+ type ExplainMetrics struct

+ ExecutionStats *ExecutionStats

+ PlanSummary *PlanSummary

+ type ExplainOptions struct

+ Analyze bool

type FindNearestOptions

+ DistanceResultField string

+ DistanceThreshold *float64

+ type PlanSummary struct

+ IndexesUsed []*map[string]any

type Query

+ func (q Query) WithRunOptions(opts ...RunOption) Query

+ type RunOption interface

Jul 24, 2024

Changes in this version

+ type DistanceMeasure int32

+ const DistanceMeasureCosine

+ const DistanceMeasureDotProduct

+ const DistanceMeasureEuclidean

+ type FindNearestOptions struct

type Query

+ func (q Query) FindNearest(vectorField string, queryVector any, limit int, measure DistanceMeasure, ...) VectorQuery

+ func (q Query) FindNearestPath(vectorFieldPath FieldPath, queryVector any, limit int, measure DistanceMeasure, ...) VectorQuery

+ type Vector32 []float32

+ type Vector64 []float64

+ type VectorQuery struct

+ func (vq VectorQuery) Documents(ctx context.Context) *DocumentIterator

Oct 19, 2023

Changes in this version

type AggregationQuery

+ func (a *AggregationQuery) Transaction(tx *Transaction) *AggregationQuery

+ func (a *AggregationQuery) WithAvg(path string, alias string) *AggregationQuery

+ func (a *AggregationQuery) WithAvgPath(fp FieldPath, alias string) *AggregationQuery

+ func (a *AggregationQuery) WithSum(path string, alias string) *AggregationQuery

+ func (a *AggregationQuery) WithSumPath(fp FieldPath, alias string) *AggregationQuery

Sep 18, 2023

Changes in this version

+ const DefaultDatabaseID

type Client

+ func NewClientWithDatabase(ctx context.Context, projectID string, databaseID string, ...) (*Client, error)

May 22, 2023

Changes in this version

+ type AndFilter struct

+ Filters []EntityFilter

+ type CompositeFilter interface

+ type EntityFilter interface

+ type OrFilter struct

+ Filters []EntityFilter

+ type PropertyFilter struct

+ Operator string

+ Path string

+ Value interface{}

+ type PropertyPathFilter struct

+ Operator string

+ Path FieldPath

+ Value interface{}

type Query

+ func (q Query) WhereEntity(ef EntityFilter) Query

+ type SimpleFilter interface

Oct 17, 2022

Changes in this version

+ type AggregationQuery struct

+ func (a *AggregationQuery) Get(ctx context.Context) (AggregationResult, error)

+ func (a *AggregationQuery) WithCount(alias string) *AggregationQuery

+ type AggregationResult map[string]interface

type Client

+ func (c *Client) WithReadOptions(opts ...ReadOption) *Client

type CollectionRef

+ func (c *CollectionRef) WithReadOptions(opts ...ReadOption) *CollectionRef

type DocumentRef

+ func (d *DocumentRef) WithReadOptions(opts ...ReadOption) *DocumentRef

type Query

+ func (q *Query) NewAggregationQuery() *AggregationQuery

+ func (q *Query) WithReadOptions(opts ...ReadOption) *Query

+ type ReadOption interface

+ func ReadTime(t time.Time) ReadOption

type Transaction

+ func (t *Transaction) WithReadOptions(opts ...ReadOption) *Transaction

Oct 6, 2022

Changes in this version

+ type BulkWriter struct

+ func (bw *BulkWriter) Create(doc *DocumentRef, datum interface{}) (*BulkWriterJob, error)

+ func (bw *BulkWriter) Delete(doc *DocumentRef, preconds ...Precondition) (*BulkWriterJob, error)

+ func (bw *BulkWriter) End()

+ func (bw *BulkWriter) Flush()

+ func (bw *BulkWriter) Set(doc *DocumentRef, datum interface{}, opts ...SetOption) (*BulkWriterJob, error)

+ func (bw *BulkWriter) Update(doc *DocumentRef, updates []Update, preconds ...Precondition) (*BulkWriterJob, error)

+ type BulkWriterJob struct

+ func (j *BulkWriterJob) Results() (*WriteResult, error)

type Client

+ func (c *Client) BulkWriter(ctx context.Context) *BulkWriter

Sep 13, 2021

Changes in this version

type CollectionGroupRef

+ func (cgr CollectionGroupRef) GetPartitionedQueries(ctx context.Context, partitionCount int) ([]Query, error)

type Query

+ func (q Query) Deserialize(bytes []byte) (Query, error)

+ func (q Query) Serialize() ([]byte, error)

Jul 28, 2020

Changes in this version

+ func FieldTransformIncrement(n interface{}) transform

+ func FieldTransformMaximum(n interface{}) transform

+ func FieldTransformMinimum(n interface{}) transform

type Query

+ func (q Query) LimitToLast(n int) Query

Sep 13, 2019

Changes in this version

+ const DefaultTransactionMaxAttempts

+ const Delete

+ const DetectProjectID

+ const DocumentID

+ const ServerTimestamp

+ var LogWatchStreams = false

+ var ReadOnly = ro

+ func ArrayRemove(elems ...interface{}) arrayRemove

+ func ArrayUnion(elems ...interface{}) arrayUnion

+ func Increment(n interface{}) increment

+ func MaxAttempts(n int) maxAttempts

+ type Client struct

+ func NewClient(ctx context.Context, projectID string, opts ...option.ClientOption) (*Client, error)

+ func (c *Client) Batch() *WriteBatch

+ func (c *Client) Close() error

+ func (c *Client) Collection(path string) *CollectionRef

+ func (c *Client) CollectionGroup(collectionID string) *CollectionGroupRef

+ func (c *Client) Collections(ctx context.Context) *CollectionIterator

+ func (c *Client) Doc(path string) *DocumentRef

+ func (c *Client) GetAll(ctx context.Context, docRefs []*DocumentRef) (_ []*DocumentSnapshot, err error)

+ func (c *Client) RunTransaction(ctx context.Context, f func(context.Context, *Transaction) error, ...) (err error)

+ type CollectionGroupRef struct

+ type CollectionIterator struct

+ func (it *CollectionIterator) GetAll() ([]*CollectionRef, error)

+ func (it *CollectionIterator) Next() (*CollectionRef, error)

+ func (it *CollectionIterator) PageInfo() *iterator.PageInfo

+ type CollectionRef struct

+ ID string

+ Parent *DocumentRef

+ Path string

+ func (c *CollectionRef) Add(ctx context.Context, data interface{}) (*DocumentRef, *WriteResult, error)

+ func (c *CollectionRef) Doc(id string) *DocumentRef

+ func (c *CollectionRef) DocumentRefs(ctx context.Context) *DocumentRefIterator

+ func (c *CollectionRef) NewDoc() *DocumentRef

+ type Direction int32

+ const Asc

+ const Desc

+ type DocumentChange struct

+ Doc *DocumentSnapshot

+ Kind DocumentChangeKind

+ NewIndex int

+ OldIndex int

+ type DocumentChangeKind int

+ const DocumentAdded

+ const DocumentModified

+ const DocumentRemoved

+ type DocumentIterator struct

+ func (it *DocumentIterator) GetAll() ([]*DocumentSnapshot, error)

+ func (it *DocumentIterator) Next() (*DocumentSnapshot, error)

+ func (it *DocumentIterator) Stop()

+ type DocumentRef struct

+ ID string

+ Parent *CollectionRef

+ Path string

+ func (d *DocumentRef) Collection(id string) *CollectionRef

+ func (d *DocumentRef) Collections(ctx context.Context) *CollectionIterator

+ func (d *DocumentRef) Create(ctx context.Context, data interface{}) (_ *WriteResult, err error)

+ func (d *DocumentRef) Delete(ctx context.Context, preconds ...Precondition) (_ *WriteResult, err error)

+ func (d *DocumentRef) Get(ctx context.Context) (_ *DocumentSnapshot, err error)

+ func (d *DocumentRef) Set(ctx context.Context, data interface{}, opts ...SetOption) (_ *WriteResult, err error)

+ func (d *DocumentRef) Snapshots(ctx context.Context) *DocumentSnapshotIterator

+ func (d *DocumentRef) Update(ctx context.Context, updates []Update, preconds ...Precondition) (_ *WriteResult, err error)

+ type DocumentRefIterator struct

+ func (it *DocumentRefIterator) GetAll() ([]*DocumentRef, error)

+ func (it *DocumentRefIterator) Next() (*DocumentRef, error)

+ func (it *DocumentRefIterator) PageInfo() *iterator.PageInfo

+ type DocumentSnapshot struct

+ CreateTime time.Time

+ ReadTime time.Time

+ Ref *DocumentRef

+ UpdateTime time.Time

+ func (d *DocumentSnapshot) Data() map[string]interface{}

+ func (d *DocumentSnapshot) DataAt(path string) (interface{}, error)

+ func (d *DocumentSnapshot) DataAtPath(fp FieldPath) (interface{}, error)

+ func (d *DocumentSnapshot) DataTo(p interface{}) error

+ func (d *DocumentSnapshot) Exists() bool

+ type DocumentSnapshotIterator struct

+ func (it *DocumentSnapshotIterator) Next() (*DocumentSnapshot, error)

+ func (it *DocumentSnapshotIterator) Stop()

+ type FieldPath []string

+ type Precondition interface

+ var Exists Precondition

+ func LastUpdateTime(t time.Time) Precondition

+ type Query struct

+ func (q Query) Documents(ctx context.Context) *DocumentIterator

+ func (q Query) EndAt(docSnapshotOrFieldValues ...interface{}) Query

+ func (q Query) EndBefore(docSnapshotOrFieldValues ...interface{}) Query

+ func (q Query) Limit(n int) Query

+ func (q Query) Offset(n int) Query

+ func (q Query) OrderBy(path string, dir Direction) Query

+ func (q Query) OrderByPath(fp FieldPath, dir Direction) Query

+ func (q Query) Select(paths ...string) Query

+ func (q Query) SelectPaths(fieldPaths ...FieldPath) Query

+ func (q Query) Snapshots(ctx context.Context) *QuerySnapshotIterator

+ func (q Query) StartAfter(docSnapshotOrFieldValues ...interface{}) Query

+ func (q Query) StartAt(docSnapshotOrFieldValues ...interface{}) Query

+ func (q Query) Where(path, op string, value interface{}) Query

+ func (q Query) WherePath(fp FieldPath, op string, value interface{}) Query

+ type QuerySnapshot struct

+ Changes []DocumentChange

+ Documents *DocumentIterator

+ ReadTime time.Time

+ Size int

+ type QuerySnapshotIterator struct

+ Query Query

+ func (it *QuerySnapshotIterator) Next() (*QuerySnapshot, error)

+ func (it *QuerySnapshotIterator) Stop()

+ type Queryer interface

+ type SetOption interface

+ var MergeAll SetOption = merge{}

+ func Merge(fps ...FieldPath) SetOption

+ type Transaction struct

+ func (t *Transaction) Create(dr *DocumentRef, data interface{}) error

+ func (t *Transaction) Delete(dr *DocumentRef, opts ...Precondition) error

+ func (t *Transaction) DocumentRefs(cr *CollectionRef) *DocumentRefIterator

+ func (t *Transaction) Documents(q Queryer) *DocumentIterator

+ func (t *Transaction) Get(dr *DocumentRef) (*DocumentSnapshot, error)

+ func (t *Transaction) GetAll(drs []*DocumentRef) ([]*DocumentSnapshot, error)

+ func (t *Transaction) Set(dr *DocumentRef, data interface{}, opts ...SetOption) error

+ func (t *Transaction) Update(dr *DocumentRef, data []Update, opts ...Precondition) error

+ type TransactionOption interface

+ type Update struct

+ FieldPath FieldPath

+ Path string

+ Value interface{}

+ type WriteBatch struct

+ func (b *WriteBatch) Commit(ctx context.Context) (_ []*WriteResult, err error)

+ func (b *WriteBatch) Create(dr *DocumentRef, data interface{}) *WriteBatch

+ func (b *WriteBatch) Delete(dr *DocumentRef, opts ...Precondition) *WriteBatch

+ func (b *WriteBatch) Set(dr *DocumentRef, data interface{}, opts ...SetOption) *WriteBatch

+ func (b *WriteBatch) Update(dr *DocumentRef, data []Update, opts ...Precondition) *WriteBatch

+ type WriteResult struct

+ UpdateTime time.Time