Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	BundledQuery_LimitType_name = map[int32]string{
		0: "FIRST",
		1: "LAST",
	}
	BundledQuery_LimitType_value = map[string]int32{
		"FIRST": 0,
		"LAST":  1,
	}
)

Enum value maps for BundledQuery_LimitType.

View Source
var File_google_firestore_bundle_bundle_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type BundleElement

type BundleElement struct {

	// Types that are assignable to ElementType:
	//	*BundleElement_Metadata
	//	*BundleElement_NamedQuery
	//	*BundleElement_DocumentMetadata
	//	*BundleElement_Document
	ElementType isBundleElement_ElementType `protobuf_oneof:"element_type"`
	// contains filtered or unexported fields
}

A Firestore bundle is a length-prefixed stream of JSON representations of `BundleElement`. Only one `BundleMetadata` is expected, and it should be the first element. The named queries follow after `metadata`. Every `document_metadata` is immediately followed by a `document`.

func (*BundleElement) Descriptor

func (*BundleElement) Descriptor() ([]byte, []int)

Deprecated: Use BundleElement.ProtoReflect.Descriptor instead.

func (*BundleElement) GetDocument

func (x *BundleElement) GetDocument() *v1.Document

func (*BundleElement) GetDocumentMetadata

func (x *BundleElement) GetDocumentMetadata() *BundledDocumentMetadata

func (*BundleElement) GetElementType

func (m *BundleElement) GetElementType() isBundleElement_ElementType

func (*BundleElement) GetMetadata

func (x *BundleElement) GetMetadata() *BundleMetadata

func (*BundleElement) GetNamedQuery

func (x *BundleElement) GetNamedQuery() *NamedQuery

func (*BundleElement) ProtoMessage

func (*BundleElement) ProtoMessage()

func (*BundleElement) ProtoReflect

func (x *BundleElement) ProtoReflect() protoreflect.Message

func (*BundleElement) Reset

func (x *BundleElement) Reset()

func (*BundleElement) String

func (x *BundleElement) String() string

type BundleElement_Document

type BundleElement_Document struct {
	Document *v1.Document `protobuf:"bytes,4,opt,name=document,proto3,oneof"`
}

type BundleElement_DocumentMetadata

type BundleElement_DocumentMetadata struct {
	DocumentMetadata *BundledDocumentMetadata `protobuf:"bytes,3,opt,name=document_metadata,json=documentMetadata,proto3,oneof"`
}

type BundleElement_Metadata

type BundleElement_Metadata struct {
	Metadata *BundleMetadata `protobuf:"bytes,1,opt,name=metadata,proto3,oneof"`
}

type BundleElement_NamedQuery

type BundleElement_NamedQuery struct {
	NamedQuery *NamedQuery `protobuf:"bytes,2,opt,name=named_query,json=namedQuery,proto3,oneof"`
}

type BundleMetadata

type BundleMetadata struct {

	// The ID of the bundle.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Time at which the documents snapshot is taken for this bundle.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// The schema version of the bundle.
	Version uint32 `protobuf:"varint,3,opt,name=version,proto3" json:"version,omitempty"`
	// The number of documents in the bundle.
	TotalDocuments uint32 `protobuf:"varint,4,opt,name=total_documents,json=totalDocuments,proto3" json:"total_documents,omitempty"`
	// The size of the bundle in bytes, excluding this `BundleMetadata`.
	TotalBytes uint64 `protobuf:"varint,5,opt,name=total_bytes,json=totalBytes,proto3" json:"total_bytes,omitempty"`
	// contains filtered or unexported fields
}

Metadata describing the bundle file/stream.

func (*BundleMetadata) Descriptor

func (*BundleMetadata) Descriptor() ([]byte, []int)

Deprecated: Use BundleMetadata.ProtoReflect.Descriptor instead.

func (*BundleMetadata) GetCreateTime

func (x *BundleMetadata) GetCreateTime() *timestamppb.Timestamp

func (*BundleMetadata) GetId

func (x *BundleMetadata) GetId() string

func (*BundleMetadata) GetTotalBytes

func (x *BundleMetadata) GetTotalBytes() uint64

func (*BundleMetadata) GetTotalDocuments

func (x *BundleMetadata) GetTotalDocuments() uint32

func (*BundleMetadata) GetVersion

func (x *BundleMetadata) GetVersion() uint32

func (*BundleMetadata) ProtoMessage

func (*BundleMetadata) ProtoMessage()

func (*BundleMetadata) ProtoReflect

func (x *BundleMetadata) ProtoReflect() protoreflect.Message

func (*BundleMetadata) Reset

func (x *BundleMetadata) Reset()

func (*BundleMetadata) String

func (x *BundleMetadata) String() string

type BundledDocumentMetadata

type BundledDocumentMetadata struct {

	// The document key of a bundled document.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The snapshot version of the document data bundled.
	ReadTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=read_time,json=readTime,proto3" json:"read_time,omitempty"`
	// Whether the document exists.
	Exists bool `protobuf:"varint,3,opt,name=exists,proto3" json:"exists,omitempty"`
	// The names of the queries in this bundle that this document matches to.
	Queries []string `protobuf:"bytes,4,rep,name=queries,proto3" json:"queries,omitempty"`
	// contains filtered or unexported fields
}

Metadata describing a Firestore document saved in the bundle.

func (*BundledDocumentMetadata) Descriptor

func (*BundledDocumentMetadata) Descriptor() ([]byte, []int)

Deprecated: Use BundledDocumentMetadata.ProtoReflect.Descriptor instead.

func (*BundledDocumentMetadata) GetExists

func (x *BundledDocumentMetadata) GetExists() bool

func (*BundledDocumentMetadata) GetName

func (x *BundledDocumentMetadata) GetName() string

func (*BundledDocumentMetadata) GetQueries

func (x *BundledDocumentMetadata) GetQueries() []string

func (*BundledDocumentMetadata) GetReadTime

func (x *BundledDocumentMetadata) GetReadTime() *timestamppb.Timestamp

func (*BundledDocumentMetadata) ProtoMessage

func (*BundledDocumentMetadata) ProtoMessage()

func (*BundledDocumentMetadata) ProtoReflect

func (x *BundledDocumentMetadata) ProtoReflect() protoreflect.Message

func (*BundledDocumentMetadata) Reset

func (x *BundledDocumentMetadata) Reset()

func (*BundledDocumentMetadata) String

func (x *BundledDocumentMetadata) String() string

type BundledQuery

type BundledQuery struct {

	// The parent resource name.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The query to run.
	//
	// Types that are assignable to QueryType:
	//	*BundledQuery_StructuredQuery
	QueryType isBundledQuery_QueryType `protobuf_oneof:"query_type"`
	LimitType BundledQuery_LimitType   `` /* 141-byte string literal not displayed */
	// contains filtered or unexported fields
}

Encodes a query saved in the bundle.

func (*BundledQuery) Descriptor

func (*BundledQuery) Descriptor() ([]byte, []int)

Deprecated: Use BundledQuery.ProtoReflect.Descriptor instead.

func (*BundledQuery) GetLimitType

func (x *BundledQuery) GetLimitType() BundledQuery_LimitType

func (*BundledQuery) GetParent

func (x *BundledQuery) GetParent() string

func (*BundledQuery) GetQueryType

func (m *BundledQuery) GetQueryType() isBundledQuery_QueryType

func (*BundledQuery) GetStructuredQuery

func (x *BundledQuery) GetStructuredQuery() *v1.StructuredQuery

func (*BundledQuery) ProtoMessage

func (*BundledQuery) ProtoMessage()

func (*BundledQuery) ProtoReflect

func (x *BundledQuery) ProtoReflect() protoreflect.Message

func (*BundledQuery) Reset

func (x *BundledQuery) Reset()

func (*BundledQuery) String

func (x *BundledQuery) String() string

type BundledQuery_LimitType

type BundledQuery_LimitType int32

If the query is a limit query, should the limit be applied to the beginning or the end of results.

const (
	BundledQuery_FIRST BundledQuery_LimitType = 0
	BundledQuery_LAST  BundledQuery_LimitType = 1
)

func (BundledQuery_LimitType) Descriptor

func (BundledQuery_LimitType) Enum

func (BundledQuery_LimitType) EnumDescriptor

func (BundledQuery_LimitType) EnumDescriptor() ([]byte, []int)

Deprecated: Use BundledQuery_LimitType.Descriptor instead.

func (BundledQuery_LimitType) Number

func (BundledQuery_LimitType) String

func (x BundledQuery_LimitType) String() string

func (BundledQuery_LimitType) Type

type BundledQuery_StructuredQuery

type BundledQuery_StructuredQuery struct {
	// A structured query.
	StructuredQuery *v1.StructuredQuery `protobuf:"bytes,2,opt,name=structured_query,json=structuredQuery,proto3,oneof"`
}

type NamedQuery

type NamedQuery struct {

	// Name of the query, such that client can use the name to load this query
	// from bundle, and resume from when the query results are materialized
	// into this bundle.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The query saved in the bundle.
	BundledQuery *BundledQuery `protobuf:"bytes,2,opt,name=bundled_query,json=bundledQuery,proto3" json:"bundled_query,omitempty"`
	// The read time of the query, when it is used to build the bundle. This is useful to
	// resume the query from the bundle, once it is loaded by client SDKs.
	ReadTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=read_time,json=readTime,proto3" json:"read_time,omitempty"`
	// contains filtered or unexported fields
}

A Query associated with a name, created as part of the bundle file, and can be read by client SDKs once the bundle containing them is loaded.

func (*NamedQuery) Descriptor

func (*NamedQuery) Descriptor() ([]byte, []int)

Deprecated: Use NamedQuery.ProtoReflect.Descriptor instead.

func (*NamedQuery) GetBundledQuery

func (x *NamedQuery) GetBundledQuery() *BundledQuery

func (*NamedQuery) GetName

func (x *NamedQuery) GetName() string

func (*NamedQuery) GetReadTime

func (x *NamedQuery) GetReadTime() *timestamppb.Timestamp

func (*NamedQuery) ProtoMessage

func (*NamedQuery) ProtoMessage()

func (*NamedQuery) ProtoReflect

func (x *NamedQuery) ProtoReflect() protoreflect.Message

func (*NamedQuery) Reset

func (x *NamedQuery) Reset()

func (*NamedQuery) String

func (x *NamedQuery) String() string

Source Files