github.com/dolthub/dolt/go@v0.40.5-0.20240520175717-68db7794bea6/libraries/doltcore/sqle/globalstate/global_state.go

// Copyright 2021 Dolthub, Inc.
//
// 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 globalstate

import "github.com/dolthub/go-mysql-server/sql"

// GlobalState is just a holding interface for pieces of global state, of which the auto increment tracking info is
// the only example at the moment.
type GlobalState interface {
	// AutoIncrementTracker returns the auto increment tracker for this global state.
	AutoIncrementTracker(ctx *sql.Context) (AutoIncrementTracker, error)
}

// GlobalStateProvider is an optional interface for databases that provide global state tracking
type GlobalStateProvider interface {
	GetGlobalState() GlobalState
}