1/*
2 * cluster.go
3 *
4 * This source file is part of the FoundationDB open source project
5 *
6 * Copyright 2013-2018 Apple Inc. and the FoundationDB project authors
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 *     http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
19 */
20
21// FoundationDB Go API
22
23package fdb
24
25/*
26 #define FDB_API_VERSION 610
27 #include <foundationdb/fdb_c.h>
28*/
29import "C"
30
31// Deprecated: Use OpenDatabase or OpenDefault to obtain a database handle directly
32// Cluster is a handle to a FoundationDB cluster. Cluster is a lightweight
33// object that may be efficiently copied, and is safe for concurrent use by
34// multiple goroutines.
35type Cluster struct {
36	clusterFileName string
37}
38
39// Deprecated: Use OpenDatabase or OpenDefault to obtain a database handle directly
40// OpenDatabase returns a database handle from the FoundationDB cluster.
41//
42// The database name must be []byte("DB").
43func (c Cluster) OpenDatabase(dbName []byte) (Database, error) {
44	return Open(c.clusterFileName, dbName)
45}
46