github.com/KinWaiYuen/client-go/v2@v2.5.4/internal/locate/accessmode.go (about)

     1  // Copyright 2021 TiKV Authors
     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  // NOTE: The code in this file is based on code from the
    16  // TiDB project, licensed under the Apache License v 2.0
    17  //
    18  // https://github.com/pingcap/tidb/tree/cc5e161ac06827589c4966674597c137cc9e809c/store/tikv/locate/accessmode.go
    19  //
    20  
    21  // Copyright 2021 PingCAP, Inc.
    22  //
    23  // Licensed under the Apache License, Version 2.0 (the "License");
    24  // you may not use this file except in compliance with the License.
    25  // You may obtain a copy of the License at
    26  //
    27  //     http://www.apache.org/licenses/LICENSE-2.0
    28  //
    29  // Unless required by applicable law or agreed to in writing, software
    30  // distributed under the License is distributed on an "AS IS" BASIS,
    31  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    32  // See the License for the specific language governing permissions and
    33  // limitations under the License.
    34  
    35  package locate
    36  
    37  import (
    38  	"fmt"
    39  )
    40  
    41  // accessMode uses to index stores for different region cache access requirements.
    42  type accessMode int
    43  
    44  const (
    45  	// tiKVOnly indicates stores list that use for TiKv access(include both leader request and follower read).
    46  	tiKVOnly accessMode = iota
    47  	// tiFlashOnly indicates stores list that use for TiFlash request.
    48  	tiFlashOnly
    49  	// numAccessMode reserved to keep max access mode value.
    50  	numAccessMode
    51  )
    52  
    53  func (a accessMode) String() string {
    54  	switch a {
    55  	case tiKVOnly:
    56  		return "TiKvOnly"
    57  	case tiFlashOnly:
    58  		return "TiFlashOnly"
    59  	default:
    60  		return fmt.Sprintf("%d", a)
    61  	}
    62  }