txnmongo

Documentation

Overview

Copyright 2024 The txnmongo Authors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Package txnmongo provides a transaction adapter for MongoDB, seamlessly integrating with the txn package to enable distributed transaction management across multiple data sources, including MongoDB.

Index

• type MAdapter
  • func New(client *mongo.Client) MAdapter

Types

type MAdapter

type MAdapter interface {
	txn.Adapter

	// GetCurrent returns the current context.Context to use for executing MongoDB commands.
	// Depending on the transaction state, this may be the original context or a
	// mongo.SessionContext.
	GetCurrent(ctx context.Context) context.Context
}

MAdapter is the interface for interacting with MongoDB within a transaction. It extends the txn.Adapter interface to provide additional MongoDB-specific functionality.

func New

func New(client *mongo.Client) MAdapter

New creates a new MAdapter instance using the provided mongo.Client.