...

Source file src/github.com/go-kivik/kivik/v4/constants.go

Documentation: github.com/go-kivik/kivik/v4

     1  // Licensed under the Apache License, Version 2.0 (the "License"); you may not
     2  // use this file except in compliance with the License. You may obtain a copy of
     3  // the License at
     4  //
     5  //  http://www.apache.org/licenses/LICENSE-2.0
     6  //
     7  // Unless required by applicable law or agreed to in writing, software
     8  // distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
     9  // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
    10  // License for the specific language governing permissions and limitations under
    11  // the License.
    12  
    13  package kivik
    14  
    15  const (
    16  	// Version is the version of the Kivik library.
    17  	Version = "4.3.2"
    18  )
    19  
    20  // SessionCookieName is the name of the CouchDB session cookie.
    21  const SessionCookieName = "AuthSession"
    22  
    23  // UserPrefix is the mandatory CouchDB [user prefix].
    24  //
    25  // [user prefix]: https://docs.couchdb.org/en/latest/intro/security.html#org-couchdb-user
    26  const UserPrefix = "org.couchdb.user:"
    27  
    28  // EndKeySuffix is a high Unicode character (0xfff0) useful for appending to an
    29  // endkey argument, when doing a ranged search, as described [here].
    30  //
    31  // For example, to return all results with keys beginning with "foo":
    32  //
    33  //	rows, err := db.Query(context.TODO(), "ddoc", "view", kivik.Params(map[string]interface{}{
    34  //	    "startkey": "foo",
    35  //	    "endkey":   "foo" + kivik.EndKeySuffix,
    36  //	}))
    37  //
    38  // [here]: http://couchdb.readthedocs.io/en/latest/ddocs/views/collation.html#string-ranges
    39  const EndKeySuffix = string(rune(0xfff0))
    40  

View as plain text