github.com/hasnat/dolt/go@v0.0.0-20210628190320-9eb5d843fbb7/store/datas/commit_options.go (about)

     1  // Copyright 2019 Dolthub, Inc.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  //
    15  // This file incorporates work covered by the following copyright and
    16  // permission notice:
    17  //
    18  // Copyright 2016 Attic Labs, Inc. All rights reserved.
    19  // Licensed under the Apache License, version 2.0:
    20  // http://www.apache.org/licenses/LICENSE-2.0
    21  
    22  package datas
    23  
    24  import (
    25  	"github.com/dolthub/dolt/go/store/merge"
    26  	"github.com/dolthub/dolt/go/store/types"
    27  )
    28  
    29  // CommitOptions is used to pass options into Commit.
    30  type CommitOptions struct {
    31  	// ParentsList, if provided is the parent commits of the commit we are
    32  	// creating.
    33  	ParentsList types.List
    34  
    35  	// Meta is a Struct that describes arbitrary metadata about this Commit,
    36  	// e.g. a timestamp or descriptive text.
    37  	Meta types.Struct
    38  
    39  	// Policy will be called to attempt to merge this Commit with the current
    40  	// Head, if this is not a fast-forward. If Policy is nil, no merging will
    41  	// be attempted. Note that because Commit() retries in some cases, Policy
    42  	// might also be called multiple times with different values.
    43  	Policy merge.Policy
    44  }