cluster.go

// Licensed under the Apache License, Version 2.0 (the "License"); you may not
// use this file except in compliance with the License. You may obtain a copy of
// the License at
//
//  http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
// License for the specific language governing permissions and limitations under
// the License.

package kivik

import (
	"context"

	"github.com/go-kivik/kivik/v4/driver"
)

// ClusterStatus returns the current [cluster status].
//
// [cluster status]: http://docs.couchdb.org/en/stable/api/server/common.html#cluster-setup
func (c *Client) ClusterStatus(ctx context.Context, options ...Option) (string, error) {
	endQuery, err := c.startQuery()
	if err != nil {
		return "", err
	}
	defer endQuery()
	cluster, ok := c.driverClient.(driver.Cluster)
	if !ok {
		return "", errClusterNotImplemented
	}
	return cluster.ClusterStatus(ctx, multiOptions(options))
}

// ClusterSetup performs the requested [cluster action]. action should be
// an object understood by the driver. For the CouchDB driver, this means an
// object which is marshalable to a JSON object of the expected format.
//
// [cluster action]: http://docs.couchdb.org/en/stable/api/server/common.html#post--_cluster_setup
func (c *Client) ClusterSetup(ctx context.Context, action interface{}) error {
	endQuery, err := c.startQuery()
	if err != nil {
		return err
	}
	defer endQuery()
	cluster, ok := c.driverClient.(driver.Cluster)
	if !ok {
		return errClusterNotImplemented
	}
	return cluster.ClusterSetup(ctx, action)
}

// ClusterMembership contains the list of known nodes, and cluster nodes, as returned
// by [Client.Membership].
type ClusterMembership struct {
	AllNodes     []string `json:"all_nodes"`
	ClusterNodes []string `json:"cluster_nodes"`
}

// Membership returns a list of known CouchDB [nodes in the cluster].
//
// [nodes in the cluster]: https://docs.couchdb.org/en/latest/api/server/common.html#get--_membership
func (c *Client) Membership(ctx context.Context) (*ClusterMembership, error) {
	endQuery, err := c.startQuery()
	if err != nil {
		return nil, err
	}
	defer endQuery()
	cluster, ok := c.driverClient.(driver.Cluster)
	if !ok {
		return nil, errClusterNotImplemented
	}
	nodes, err := cluster.Membership(ctx)
	return (*ClusterMembership)(nodes), err
}