v2: update public API

[ligurio]

Unlike other program languages like Java and Python that use access modifiers such as public, private, or protected to specify scope, Go determines if an item is exported and unexported through how it is declared. Exporting an item in this case makes it visible outside the current package. If it’s not exported, it is only visible and usable from within the package it was defined. This external visibility is controlled by capitalizing the first letter of the item declared. All declarations, such as Types, Variables, Constants, Functions, etc., that start with a capital letter are visible outside the current package.

There are many things in go-connector that exposed as a part of public API. We need to update a public API and probably make some of these things invisible for external users.

We need to document this if we want to keep these things in a public API.

NOTE: It is a breaking change and next release with these changes should bump a MAJOR version.

• constants declared in const.go,

  go-tarantool/const.go

  Lines 4 to 31 in 31ebde8

  	SelectRequest = 1
  	InsertRequest = 2
  	ReplaceRequest = 3
  	UpdateRequest = 4
  	DeleteRequest = 5
  	CallRequest = 6 /* call in 1.6 format */
  	AuthRequest = 7
  	EvalRequest = 8
  	UpsertRequest = 9
  	Call17Request = 10
  	PingRequest = 64
  	SubscribeRequest = 66
  	KeyCode = 0x00
  	KeySync = 0x01
  	KeySpaceNo = 0x10
  	KeyIndexNo = 0x11
  	KeyLimit = 0x12
  	KeyOffset = 0x13
  	KeyIterator = 0x14
  	KeyKey = 0x20
  	KeyTuple = 0x21
  	KeyFunctionName = 0x22
  	KeyUserName = 0x23
  	KeyExpression = 0x27
  	KeyDefTuple = 0x28
  	KeyData = 0x30
  	KeyError = 0x31

• constants declared in consts.go,

  go-tarantool/const.go

  Lines 17 to 31 in 2c3af56

  	KeyCode = 0x00
  	KeySync = 0x01
  	KeySpaceNo = 0x10
  	KeyIndexNo = 0x11
  	KeyLimit = 0x12
  	KeyOffset = 0x13
  	KeyIterator = 0x14
  	KeyKey = 0x20
  	KeyTuple = 0x21
  	KeyFunctionName = 0x22
  	KeyUserName = 0x23
  	KeyExpression = 0x27
  	KeyDefTuple = 0x28
  	KeyData = 0x30
  	KeyError = 0x31

• constants declared in consts.go,

  go-tarantool/const.go

  Lines 46 to 51 in 2c3af56

  	RLimitDrop = 1
  	RLimitWait = 2
  	OkCode = uint32(0)
  	ErrorCodeBit = 0x8000
  	PacketLengthBytes = 5

• Connector interface in connector.go,

  go-tarantool/connector.go

  Lines 5 to 40 in 31ebde8

  	type Connector interface {
  	ConnectedNow() bool
  	Close() error
  	Ping() (resp *Response, err error)
  	ConfiguredTimeout() time.Duration
  	Select(space, index interface{}, offset, limit, iterator uint32, key interface{}) (resp *Response, err error)
  	Insert(space interface{}, tuple interface{}) (resp *Response, err error)
  	Replace(space interface{}, tuple interface{}) (resp *Response, err error)
  	Delete(space, index interface{}, key interface{}) (resp *Response, err error)
  	Update(space, index interface{}, key, ops interface{}) (resp *Response, err error)
  	Upsert(space interface{}, tuple, ops interface{}) (resp *Response, err error)
  	Call(functionName string, args interface{}) (resp *Response, err error)
  	Call17(functionName string, args interface{}) (resp *Response, err error)
  	Eval(expr string, args interface{}) (resp *Response, err error)
  	GetTyped(space, index interface{}, key interface{}, result interface{}) (err error)
  	SelectTyped(space, index interface{}, offset, limit, iterator uint32, key interface{}, result interface{}) (err error)
  	InsertTyped(space interface{}, tuple interface{}, result interface{}) (err error)
  	ReplaceTyped(space interface{}, tuple interface{}, result interface{}) (err error)
  	DeleteTyped(space, index interface{}, key interface{}, result interface{}) (err error)
  	UpdateTyped(space, index interface{}, key, ops interface{}, result interface{}) (err error)
  	CallTyped(functionName string, args interface{}, result interface{}) (err error)
  	Call17Typed(functionName string, args interface{}, result interface{}) (err error)
  	EvalTyped(expr string, args interface{}, result interface{}) (err error)
  	SelectAsync(space, index interface{}, offset, limit, iterator uint32, key interface{}) *Future
  	InsertAsync(space interface{}, tuple interface{}) *Future
  	ReplaceAsync(space interface{}, tuple interface{}) *Future
  	DeleteAsync(space, index interface{}, key interface{}) *Future
  	UpdateAsync(space, index interface{}, key, ops interface{}) *Future
  	UpsertAsync(space interface{}, tuple interface{}, ops interface{}) *Future
  	CallAsync(functionName string, args interface{}) *Future
  	Call17Async(functionName string, args interface{}) *Future
  	EvalAsync(expr string, args interface{}) *Future
  	}

• Deadline methods,

  go-tarantool/deadline_io.go

  Lines 8 to 27 in 31ebde8

  	type DeadlineIO struct {
  	to time.Duration
  	c net.Conn
  	}
  	func (d *DeadlineIO) Write(b []byte) (n int, err error) {
  	if d.to > 0 {
  	d.c.SetWriteDeadline(time.Now().Add(d.to))
  	}
  	n, err = d.c.Write(b)
  	return
  	}
  	func (d *DeadlineIO) Read(b []byte) (n int, err error) {
  	if d.to > 0 {
  	d.c.SetReadDeadline(time.Now().Add(d.to))
  	}
  	n, err = d.c.Read(b)
  	return
  	}

• UUID ext type constant

  go-tarantool/uuid/uuid.go

  Line 15 in 2c3af56

  const UUID_extId = 2

• smallbuf api,

  go-tarantool/smallbuf.go

  Lines 13 to 97 in 7897baf

  	func (s *smallBuf) Read(d []byte) (l int, err error) {
  	l = len(s.b) - s.p
  	if l == 0 && len(d) > 0 {
  	return 0, io.EOF
  	}
  	if l > len(d) {
  	l = len(d)
  	}
  	copy(d, s.b[s.p:])
  	s.p += l
  	return l, nil
  	}
  	func (s *smallBuf) ReadByte() (b byte, err error) {
  	if s.p == len(s.b) {
  	return 0, io.EOF
  	}
  	b = s.b[s.p]
  	s.p++
  	return b, nil
  	}
  	func (s *smallBuf) UnreadByte() error {
  	if s.p == 0 {
  	return errors.New("Could not unread")
  	}
  	s.p--
  	return nil
  	}
  	func (s *smallBuf) Len() int {
  	return len(s.b) - s.p
  	}
  	func (s *smallBuf) Bytes() []byte {
  	if len(s.b) > s.p {
  	return s.b[s.p:]
  	}
  	return nil
  	}
  	type smallWBuf struct {
  	b []byte
  	sum uint
  	n uint
  	}
  	func (s *smallWBuf) Write(b []byte) (int, error) {
  	s.b = append(s.b, b...)
  	return len(s.b), nil
  	}
  	func (s *smallWBuf) WriteByte(b byte) error {
  	s.b = append(s.b, b)
  	return nil
  	}
  	func (s *smallWBuf) WriteString(ss string) (int, error) {
  	s.b = append(s.b, ss...)
  	return len(ss), nil
  	}
  	func (s smallWBuf) Len() int {
  	return len(s.b)
  	}
  	func (s smallWBuf) Cap() int {
  	return cap(s.b)
  	}
  	func (s *smallWBuf) Trunc(n int) {
  	s.b = s.b[:n]
  	}
  	func (s *smallWBuf) Reset() {
  	s.sum = uint(uint64(s.sum)*15/16) + uint(len(s.b))
  	if s.n < 16 {
  	s.n++
  	}
  	if cap(s.b) > 1024 && s.sum/s.n < uint(cap(s.b))/4 {
  	s.b = make([]byte, 0, s.sum/s.n)
  	} else {
  	s.b = s.b[:0]
  	}
  	}

[oleg-jukovec]

• RoundRobinStrategy

https://github.com/tarantool/go-tarantool/blob/d6d0031d7a0ce9959edf57f9407bba9652a37506/connection_pool/round_robin.go

• DeadlineIO

https://github.com/tarantool/go-tarantool/blob/d7a422b425602263eb52e206d98feeb297eb1fa7/deadline_io.go

• Missed comments for Field

go-tarantool/schema.go

Lines 130 to 135 in d7a422b

	type Field struct {
	Id uint32
	Name string
	Type string
	}

• Missed comments for IndexField

go-tarantool/schema.go

Lines 245 to 249 in d7a422b

	type IndexField struct {
	Id uint32
	Type string
	}

• Err constants outdated

go-tarantool/errors.go

Lines 62 to 174 in d7a422b

	const (
	ErrUnknown = 0 // Unknown error
	ErrIllegalParams = 1 // Illegal parameters, %s
	ErrMemoryIssue = 2 // Failed to allocate %u bytes in %s for %s
	ErrTupleFound = 3 // Duplicate key exists in unique index '%s' in space '%s'
	ErrTupleNotFound = 4 // Tuple doesn't exist in index '%s' in space '%s'
	ErrUnsupported = 5 // %s does not support %s
	ErrNonmaster = 6 // Can't modify data on a replication slave. My master is: %s
	ErrReadonly = 7 // Can't modify data because this server is in read-only mode.
	ErrInjection = 8 // Error injection '%s'
	ErrCreateSpace = 9 // Failed to create space '%s': %s
	ErrSpaceExists = 10 // Space '%s' already exists
	ErrDropSpace = 11 // Can't drop space '%s': %s
	ErrAlterSpace = 12 // Can't modify space '%s': %s
	ErrIndexType = 13 // Unsupported index type supplied for index '%s' in space '%s'
	ErrModifyIndex = 14 // Can't create or modify index '%s' in space '%s': %s
	ErrLastDrop = 15 // Can't drop the primary key in a system space, space '%s'
	ErrTupleFormatLimit = 16 // Tuple format limit reached: %u
	ErrDropPrimaryKey = 17 // Can't drop primary key in space '%s' while secondary keys exist
	ErrKeyPartType = 18 // Supplied key type of part %u does not match index part type: expected %s
	ErrExactMatch = 19 // Invalid key part count in an exact match (expected %u, got %u)
	ErrInvalidMsgpack = 20 // Invalid MsgPack - %s
	ErrProcRet = 21 // msgpack.encode: can not encode Lua type '%s'
	ErrTupleNotArray = 22 // Tuple/Key must be MsgPack array
	ErrFieldType = 23 // Tuple field %u type does not match one required by operation: expected %s
	ErrFieldTypeMismatch = 24 // Ambiguous field type in index '%s', key part %u. Requested type is %s but the field has previously been defined as %s
	ErrSplice = 25 // SPLICE error on field %u: %s
	ErrArgType = 26 // Argument type in operation '%c' on field %u does not match field type: expected a %s
	ErrTupleIsTooLong = 27 // Tuple is too long %u
	ErrUnknownUpdateOp = 28 // Unknown UPDATE operation
	ErrUpdateField = 29 // Field %u UPDATE error: %s
	ErrFiberStack = 30 // Can not create a new fiber: recursion limit reached
	ErrKeyPartCount = 31 // Invalid key part count (expected [0..%u], got %u)
	ErrProcLua = 32 // %s
	ErrNoSuchProc = 33 // Procedure '%.*s' is not defined
	ErrNoSuchTrigger = 34 // Trigger is not found
	ErrNoSuchIndex = 35 // No index #%u is defined in space '%s'
	ErrNoSuchSpace = 36 // Space '%s' does not exist
	ErrNoSuchField = 37 // Field %d was not found in the tuple
	ErrSpaceFieldCount = 38 // Tuple field count %u does not match space '%s' field count %u
	ErrIndexFieldCount = 39 // Tuple field count %u is less than required by a defined index (expected %u)
	ErrWalIo = 40 // Failed to write to disk
	ErrMoreThanOneTuple = 41 // More than one tuple found by get()
	ErrAccessDenied = 42 // %s access denied for user '%s'
	ErrCreateUser = 43 // Failed to create user '%s': %s
	ErrDropUser = 44 // Failed to drop user '%s': %s
	ErrNoSuchUser = 45 // User '%s' is not found
	ErrUserExists = 46 // User '%s' already exists
	ErrPasswordMismatch = 47 // Incorrect password supplied for user '%s'
	ErrUnknownRequestType = 48 // Unknown request type %u
	ErrUnknownSchemaObject = 49 // Unknown object type '%s'
	ErrCreateFunction = 50 // Failed to create function '%s': %s
	ErrNoSuchFunction = 51 // Function '%s' does not exist
	ErrFunctionExists = 52 // Function '%s' already exists
	ErrFunctionAccessDenied = 53 // %s access denied for user '%s' to function '%s'
	ErrFunctionMax = 54 // A limit on the total number of functions has been reached: %u
	ErrSpaceAccessDenied = 55 // %s access denied for user '%s' to space '%s'
	ErrUserMax = 56 // A limit on the total number of users has been reached: %u
	ErrNoSuchEngine = 57 // Space engine '%s' does not exist
	ErrReloadCfg = 58 // Can't set option '%s' dynamically
	ErrCfg = 59 // Incorrect value for option '%s': %s
	ErrSophia = 60 // %s
	ErrLocalServerIsNotActive = 61 // Local server is not active
	ErrUnknownServer = 62 // Server %s is not registered with the cluster
	ErrClusterIdMismatch = 63 // Cluster id of the replica %s doesn't match cluster id of the master %s
	ErrInvalidUUID = 64 // Invalid UUID: %s
	ErrClusterIdIsRo = 65 // Can't reset cluster id: it is already assigned
	ErrReserved66 = 66 // Reserved66
	ErrServerIdIsReserved = 67 // Can't initialize server id with a reserved value %u
	ErrInvalidOrder = 68 // Invalid LSN order for server %u: previous LSN = %llu, new lsn = %llu
	ErrMissingRequestField = 69 // Missing mandatory field '%s' in request
	ErrIdentifier = 70 // Invalid identifier '%s' (expected letters, digits or an underscore)
	ErrDropFunction = 71 // Can't drop function %u: %s
	ErrIteratorType = 72 // Unknown iterator type '%s'
	ErrReplicaMax = 73 // Replica count limit reached: %u
	ErrInvalidXlog = 74 // Failed to read xlog: %lld
	ErrInvalidXlogName = 75 // Invalid xlog name: expected %lld got %lld
	ErrInvalidXlogOrder = 76 // Invalid xlog order: %lld and %lld
	ErrNoConnection = 77 // Connection is not established
	ErrTimeout = 78 // Timeout exceeded
	ErrActiveTransaction = 79 // Operation is not permitted when there is an active transaction
	ErrNoActiveTransaction = 80 // Operation is not permitted when there is no active transaction
	ErrCrossEngineTransaction = 81 // A multi-statement transaction can not use multiple storage engines
	ErrNoSuchRole = 82 // Role '%s' is not found
	ErrRoleExists = 83 // Role '%s' already exists
	ErrCreateRole = 84 // Failed to create role '%s': %s
	ErrIndexExists = 85 // Index '%s' already exists
	ErrTupleRefOverflow = 86 // Tuple reference counter overflow
	ErrRoleLoop = 87 // Granting role '%s' to role '%s' would create a loop
	ErrGrant = 88 // Incorrect grant arguments: %s
	ErrPrivGranted = 89 // User '%s' already has %s access on %s '%s'
	ErrRoleGranted = 90 // User '%s' already has role '%s'
	ErrPrivNotGranted = 91 // User '%s' does not have %s access on %s '%s'
	ErrRoleNotGranted = 92 // User '%s' does not have role '%s'
	ErrMissingSnapshot = 93 // Can't find snapshot
	ErrCantUpdatePrimaryKey = 94 // Attempt to modify a tuple field which is part of index '%s' in space '%s'
	ErrUpdateIntegerOverflow = 95 // Integer overflow when performing '%c' operation on field %u
	ErrGuestUserPassword = 96 // Setting password for guest user has no effect
	ErrTransactionConflict = 97 // Transaction has been aborted by conflict
	ErrUnsupportedRolePriv = 98 // Unsupported role privilege '%s'
	ErrLoadFunction = 99 // Failed to dynamically load function '%s': %s
	ErrFunctionLanguage = 100 // Unsupported language '%s' specified for function '%s'
	ErrRtreeRect = 101 // RTree: %s must be an array with %u (point) or %u (rectangle/box) numeric coordinates
	ErrProcC = 102 // ???
	ErrUnknownRtreeIndexDistanceType = 103 //Unknown RTREE index distance type %s
	ErrProtocol = 104 // %s
	ErrUpsertUniqueSecondaryKey = 105 // Space %s has a unique secondary index and does not support UPSERT
	ErrWrongIndexRecord = 106 // Wrong record in _index space: got {%s}, expected {%s}
	ErrWrongIndexParts = 107 // Wrong index parts (field %u): %s; expected field1 id (number), field1 type (string), ...
	ErrWrongIndexOptions = 108 // Wrong index options (field %u): %s
	ErrWrongSchemaVaersion = 109 // Wrong schema version, current: %d, in request: %u
	ErrSlabAllocMax = 110 // Failed to allocate %u bytes for tuple in the slab allocator: tuple is too large. Check 'slab_alloc_maximal' configuration option.
	)