document

type Array struct {

	// Document is the underlying document (incl. ID and ref).
	Document Document

	// Name is the name of the field.
	Name string
	// contains filtered or unexported fields
}

type ArrayField interface {

	// Retrieve returns the value of a specific field containing an array.
	//
	// note : the returned data will require a type assertion.
	Retrieve(ctx context.Context) ([]interface{}, error)

	// Append will append the provided data to the existing data (if any) of an Array field.
	Append(ctx context.Context, data []interface{}) error

	// Override will override the existing data (if any) of an Array field.
	// Note: this is the default behaviour with Firestore.
	Override(ctx context.Context, data []interface{}) error
}

type Boolean struct {

	// Document is the underlying document (incl. ID and ref).
	Document Document

	// Name is the name of the field.
	Name string
}

type BooleanField interface {

	// Retrieve returns the value of a specific field containing a Boolean (bool).
	Retrieve(ctx context.Context) (bool, error)

	// Update updates the value of a specific field containing a Boolean (bool).
	Update(ctx context.Context, with bool) error
}

type Document interface {

	// Create a document.
	Create(ctx context.Context, from interface{}) error

	// Retrieve populate the destination passed as parameter.
	//
	// note: the `to` parameter has to be a pointer.
	Retrieve(ctx context.Context, to interface{}) error

	// Exists returns true if the document exists, false otherwise.
	//
	// note: if an error occurs, false is also returned.
	Exists(ctx context.Context) bool

	// Delete removes a document from Firestore.
	Delete(ctx context.Context) error

	// Array returns a specific Array field.
	Array(name string) *Array

	// String returns a specific String field.
	String(name string) *String

	// Number returns a specific Number field.
	Number(name string) *Number

	// Boolean returns a specific Boolean field.
	Boolean(name string) *Boolean

	// Map returns a specific Map field.
	Map(name string) *Map

	// Timestamp returns a specific Timestamp field.
	Timestamp(name string) *Timestamp

	// GetDocumentRef returns a Document Reference (DocumentRef).
	GetDocumentRef() *firestore.DocumentRef

	// InBatch returns true if a WriteBatch has been started, false otherwise.
	InBatch() bool

	// Batch returns the pointer to the WriteBatch (if any), nil oherwise.
	Batch() *firestore.WriteBatch
}

type FirestoreDocument struct {

	// ColRef (firestore.CollectionRef) is a reference to the collection.
	ColRef *firestore.CollectionRef

	// ID is the ID of the document
	ID string
	// contains filtered or unexported fields
}

type Map struct {

	// Document is the underlying document (incl. ID and ref).
	Document Document

	// Name is the name of the field.
	Name string
	// contains filtered or unexported fields
}

type MapField interface {

	// Retrieve returns the value of a specific field containing a map.
	//
	// note : the returned values will require type assertion.
	Retrieve(ctx context.Context) (map[string]interface{}, error)

	// Merge will merge the provided data with the existing data (if any) of a Map field.
	// Note: this is the default behaviour with Firestore.
	Merge(ctx context.Context, data map[string]interface{}) error

	// Override will override the existing data (if any)  withthe provided data.
	Override(ctx context.Context, data map[string]interface{}) error
}

type Number struct {

	// Document is the underlying document (incl. ID and ref).
	Document Document

	// Name is the name of the field.
	Name string
	// contains filtered or unexported fields
}

type NumberField interface {

	// Retrieve returns the value of a specific field containing a number (int64).
	Retrieve(ctx context.Context) (int64, error)

	// Update the value of a specific field containing a number (int64).
	Update(ctx context.Context, with int64) error

	// Increment the value of a specific field containing a number (int64).
	// If the field doesn't exist, it will be set to 1.
	Increment(ctx context.Context) error

	// Decrement the value of a specific field containing a number (int64).
	// If the field doesn't exist, it will be set to 0.
	Decrement(ctx context.Context) error
}

type String struct {

	// Document is the underlying document (incl. ID and ref).
	Document Document

	// Name is the name of the field.
	Name string
}

type StringField interface {

	// Retrieve returns the value of a specific field containing an string.
	Retrieve(ctx context.Context) (string, error)

	// Update updates the value of a specific field containing a string.
	Update(ctx context.Context, with string) error
}

type Timestamp struct {

	// Document is the underlying document (incl. ID and ref).
	Document Document

	// Name is the name of the field.
	Name string
}

type TimestampField interface {

	// Retrieve returns the value of a specific field containing a timestamp (time.Time).
	//
	// location needs to be a value from the IANA Time Zone database (e.g. "America/Los_Angeles")
	// A time.Time zero value will be returned if an error occurs.
	Retrieve(ctx context.Context, location string) (time.Time, error)

	// Update updates the value of a specific field containing a timestamp (time.Time).
	Update(ctx context.Context, with time.Time) error
}