txngorm

Documentation

Overview

Copyright 2024 The txngorm 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 txngorm provides a transaction adapter for GORM, seamlessly integrating with the txn package to enable distributed transaction management across multiple data sources, including GORM-supported relational databases.

Key Features:

• Transactional Support: Leverages GORM's transaction capabilities to ensure atomicity of operations.
• Seamless Integration: Easily integrates with the txn package for managing transactions across different databases.
• Convenient API: Provides a simple interface (GAdapter) for interacting with GORM within a transaction.

Index

• type GAdapter
  • func New(db *gorm.DB) GAdapter

Types

type GAdapter

type GAdapter interface {
	txn.Adapter

	// GetCurrent returns the current *gorm.DB instance to use for executing GORM operations.
	// Depending on the transaction state, this may be the original db instance or a transaction object.
	GetCurrent(ctx context.Context) *gorm.DB
}

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

func New

func New(db *gorm.DB) GAdapter

New creates a new GAdapter instance using the provided *gorm.DB.