github.com/klaytn/klaytn@v1.12.1/storage/database/batch.go (about)

     1  // Modifications Copyright 2021 The klaytn Authors
     2  // Copyright 2018 The go-ethereum Authors
     3  // This file is part of the go-ethereum library.
     4  //
     5  // The go-ethereum library is free software: you can redistribute it and/or modify
     6  // it under the terms of the GNU Lesser General Public License as published by
     7  // the Free Software Foundation, either version 3 of the License, or
     8  // (at your option) any later version.
     9  //
    10  // The go-ethereum library is distributed in the hope that it will be useful,
    11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    13  // GNU Lesser General Public License for more details.
    14  //
    15  // You should have received a copy of the GNU Lesser General Public License
    16  // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
    17  //
    18  // This file is derived from ethdb/memBatch.go (2021/01/07).
    19  // Modified and improved for the klaytn development.
    20  
    21  package database
    22  
    23  // IdealBatchSize defines the size of the data batches should ideally add in one
    24  // write.
    25  const IdealBatchSize = 100 * 1024
    26  
    27  // Batch is a write-only database that commits changes to its host database
    28  // when Write is called. A Batch cannot be used concurrently.
    29  type Batch interface {
    30  	KeyValueWriter
    31  
    32  	// ValueSize retrieves the amount of data queued up for writing.
    33  	ValueSize() int
    34  
    35  	// Write flushes any accumulated data to disk.
    36  	Write() error
    37  
    38  	// Reset resets the Batch for reuse.
    39  	Reset()
    40  
    41  	// Release deallocate WriteBatch object of RocksDB.
    42  	Release()
    43  
    44  	// Replay replays the Batch contents.
    45  	Replay(w KeyValueWriter) error
    46  }
    47  
    48  // Batcher wraps the NewBatch method of a backing data store.
    49  type Batcher interface {
    50  	// NewBatch creates a write-only database that buffers changes to its host db
    51  	// until a final write is called.
    52  	NewBatch() Batch
    53  }