firestore

package
v1.0.0-dev.218 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 27, 2026 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ConfigAdd

func ConfigAdd(path string)

ConfigAdd registers shared API and gRPC configs under the given root.

func NewClient

func NewClient(ctx context.Context, plugins ...clientgrpc.Plugin) (*firestore.Client, error)

NewClient creates a Firestore client using default configuration.

func NewClientWithConfigPath

func NewClientWithConfigPath(ctx context.Context, path string, plugins ...clientgrpc.Plugin) (*firestore.Client, error)

NewClientWithConfigPath creates a Firestore client using configuration from the specified path.

func NewClientWithOptions

func NewClientWithOptions(
	ctx context.Context,
	o *Options,
	plugins ...clientgrpc.Plugin,
) (*firestore.Client, error)

NewClientWithOptions constructs a Firestore client from Options.

Types

type Options

type Options struct {
	APIOptions  apiv1.Options  `config:"apiOptions"`
	GRPCOptions grpcv1.Options `config:"grpcOptions"`
	Database    string         `config:"database"`
}

Options holds shared API/gRPC options for Firestore.

func NewOptions

func NewOptions() (*Options, error)

NewOptions loads Options from the default root.

func NewOptionsWithPath

func NewOptionsWithPath(path string) (*Options, error)

NewOptionsWithPath loads Options from the specified path.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL