README
¶
Steps to update ferret internal dir:
rm -rf ./ferret- Copy the ferret internal dir into here (
cp -r /path/to/FerretDB/internal ./ferret) - Run
RecursiveReplace.sh "github.com/FerretDB/FerretDB/internal" "github.com/zaporter/go-update-mongo/internal/ferret"
- Update the main README with the new commit of ferret you brought in and the time of the commit (not the current time)
Directories
¶
| Path | Synopsis |
|---|---|
|
ferret
|
|
|
backends
Package backends provides common interfaces ([Backend], [Database], and [Collection]) and code for all backend implementations.
|
Package backends provides common interfaces ([Backend], [Database], and [Collection]) and code for all backend implementations. |
|
backends/decorators/dummy
Package dummy provides decorators that delegate all methods to wrapped objects.
|
Package dummy provides decorators that delegate all methods to wrapped objects. |
|
backends/decorators/oplog
Package oplog provides decorators that add OpLog functionality to the backend.
|
Package oplog provides decorators that add OpLog functionality to the backend. |
|
backends/hana
Package hana provides backend for SAP HANA.
|
Package hana provides backend for SAP HANA. |
|
backends/mysql
Package mysql provides backend for MySQL and compatible databases.
|
Package mysql provides backend for MySQL and compatible databases. |
|
backends/mysql/metadata
Package metadata provides access to databases and collections information.
|
Package metadata provides access to databases and collections information. |
|
backends/mysql/metadata/pool
Package pool provides access to MySQL connections.
|
Package pool provides access to MySQL connections. |
|
backends/postgresql
Package postgresql provides backend for PostgreSQL and compatible databases.
|
Package postgresql provides backend for PostgreSQL and compatible databases. |
|
backends/postgresql/metadata
Package metadata provides access to databases and collections information.
|
Package metadata provides access to databases and collections information. |
|
backends/postgresql/metadata/pool
Package pool provides access to PostgreSQL connections.
|
Package pool provides access to PostgreSQL connections. |
|
backends/sqlite
Package sqlite provides SQLite backend.
|
Package sqlite provides SQLite backend. |
|
backends/sqlite/metadata
Package metadata provides access to databases and collections information.
|
Package metadata provides access to databases and collections information. |
|
backends/sqlite/metadata/pool
Package pool provides access to SQLite databases and their connections.
|
Package pool provides access to SQLite databases and their connections. |
|
bson
Package bson provides converters from/to BSON for built-in and `types` types.
|
Package bson provides converters from/to BSON for built-in and `types` types. |
|
bson2
Package bson2 implements encoding and decoding of BSON as defined by https://bsonspec.org/spec.html.
|
Package bson2 implements encoding and decoding of BSON as defined by https://bsonspec.org/spec.html. |
|
clientconn
Package clientconn provides client connection implementation.
|
Package clientconn provides client connection implementation. |
|
clientconn/conninfo
Package conninfo provides access to connection-specific information.
|
Package conninfo provides access to connection-specific information. |
|
clientconn/connmetrics
Package connmetrics provides listener and connection metrics.
|
Package connmetrics provides listener and connection metrics. |
|
clientconn/cursor
Package cursor provides access to cursor registry.
|
Package cursor provides access to cursor registry. |
|
handler
Package handler provides a universal handler implementation for all backends.
|
Package handler provides a universal handler implementation for all backends. |
|
handler/common
Package common contains code used to be shared by different handlers.
|
Package common contains code used to be shared by different handlers. |
|
handler/common/aggregations
Package aggregations provides aggregation pipelines.
|
Package aggregations provides aggregation pipelines. |
|
handler/common/aggregations/operators
Package operators provides aggregation operators.
|
Package operators provides aggregation operators. |
|
handler/common/aggregations/operators/accumulators
Package accumulators provides aggregation accumulator operators.
|
Package accumulators provides aggregation accumulator operators. |
|
handler/common/aggregations/stages
Package stages provides aggregation stages.
|
Package stages provides aggregation stages. |
|
handler/common/aggregations/stages/projection
Package projection provides projection for aggregations.
|
Package projection provides projection for aggregations. |
|
handler/commonpath
Package commonpath contains functions used for path.
|
Package commonpath contains functions used for path. |
|
handler/handlererrors
Package handlererrors provides handlers errors.
|
Package handlererrors provides handlers errors. |
|
handler/handlerparams
Package handlerparams provides functions for parsing handlers parameters.
|
Package handlerparams provides functions for parsing handlers parameters. |
|
handler/proxy
Package proxy sends requests to another wire protocol compatible service.
|
Package proxy sends requests to another wire protocol compatible service. |
|
handler/registry
Package registry provides a registry of handlers.
|
Package registry provides a registry of handlers. |
|
handler/sjson
Package sjson provides converters from/to jsonb with some extensions for built-in and `types` types.
|
Package sjson provides converters from/to jsonb with some extensions for built-in and `types` types. |
|
types
Package types provides Go types matching BSON types that don't have built-in Go equivalents.
|
Package types provides Go types matching BSON types that don't have built-in Go equivalents. |
|
types/fjson
Package fjson provides converters to FJSON (JSON with some extensions) for built-in and `types` types.
|
Package fjson provides converters to FJSON (JSON with some extensions) for built-in and `types` types. |
|
util/ctxutil
Package ctxutil provides context helpers.
|
Package ctxutil provides context helpers. |
|
util/debug
Package debug provides debug facilities.
|
Package debug provides debug facilities. |
|
util/debugbuild
Package debugbuild provides information about whatever this is a debug build or not.
|
Package debugbuild provides information about whatever this is a debug build or not. |
|
util/fsql
Package fsql provides database/sql utilities.
|
Package fsql provides database/sql utilities. |
|
util/hex
Package hex provides helpers for working with hex dumps.
|
Package hex provides helpers for working with hex dumps. |
|
util/iterator
Package iterator describes a generic Iterator interface and related utilities.
|
Package iterator describes a generic Iterator interface and related utilities. |
|
util/iterator/testiterator
Package testiterator provides a helper for checking iterator implementations.
|
Package testiterator provides a helper for checking iterator implementations. |
|
util/lazyerrors
Package lazyerrors provides error wrapping with file location.
|
Package lazyerrors provides error wrapping with file location. |
|
util/logging
Package logging provides logging helpers.
|
Package logging provides logging helpers. |
|
util/must
Package must provides helper functions that panic on error.
|
Package must provides helper functions that panic on error. |
|
util/observability
Package observability provides abstractions for tracing, metrics, etc.
|
Package observability provides abstractions for tracing, metrics, etc. |
|
util/password
Package password provides utilities for password hashing and verification.
|
Package password provides utilities for password hashing and verification. |
|
util/resource
Package resource provides utilities for tracking resource lifetimes.
|
Package resource provides utilities for tracking resource lifetimes. |
|
util/state
Package state stores FerretDB process state.
|
Package state stores FerretDB process state. |
|
util/telemetry
Package telemetry provides basic telemetry facilities.
|
Package telemetry provides basic telemetry facilities. |
|
util/testutil
Package testutil provides testing helpers.
|
Package testutil provides testing helpers. |
|
util/testutil/testfail
Package testfail provides testing helpers for expected tests failures.
|
Package testfail provides testing helpers for expected tests failures. |
|
util/testutil/teststress
Package teststress provides a helper for stress testing.
|
Package teststress provides a helper for stress testing. |
|
util/testutil/testtb
Package testtb provides a common testing interface.
|
Package testtb provides a common testing interface. |
|
util/tlsutil
Package tlsutil provides TLS utilities.
|
Package tlsutil provides TLS utilities. |
|
wire
Package wire provides wire protocol implementation.
|
Package wire provides wire protocol implementation. |
Click to show internal directories.
Click to hide internal directories.