graph_impl.go

//
// DISCLAIMER
//
// Copyright 2023-2024 ArangoDB GmbH, Cologne, Germany
//
// 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.
//
// Copyright holder is ArangoDB GmbH, Cologne, Germany
//

package driver

import (
	"context"
	"path"
)

// newGraph creates a new Graph implementation.
func newGraph(input graphDefinition, db *database) (Graph, error) {
	if input.Name == "" {
		return nil, WithStack(InvalidArgumentError{Message: "name is empty"})
	}
	if db == nil {
		return nil, WithStack(InvalidArgumentError{Message: "db is nil"})
	}
	return &graph{
		input: input,
		db:    db,
		conn:  db.conn,
	}, nil
}

type graph struct {
	input graphDefinition
	db    *database
	conn  Connection
}

func (g *graph) IsSmart() bool {
	return g.input.IsSmart
}

func (g *graph) IsDisjoint() bool {
	return g.input.IsDisjoint
}

func (g *graph) IsSatellite() bool {
	return g.input.IsSatellite
}

// relPath creates the relative path to this graph (`_db/<db-name>/_api/gharial/<graph-name>`)
func (g *graph) relPath() string {
	escapedName := pathEscape(g.Name())
	return path.Join(g.db.relPath(), "_api", "gharial", escapedName)
}

// Name returns the name of the graph.
func (g *graph) Name() string {
	return g.input.Name
}

// ID returns the id of the graph.
func (g *graph) ID() string {
	return g.input.ID
}

// Key returns the key of the graph.
func (g *graph) Key() DocumentID {
	return g.input.Key
}

// Rev returns the key of the graph.
func (g *graph) Rev() string {
	return g.input.Rev
}

// EdgeDefinitions returns the edge definitions of the graph.
func (g *graph) EdgeDefinitions() []EdgeDefinition {
	return g.input.EdgeDefinitions
}

// SmartGraphAttribute returns the attributes of a smart graph if there are any.
func (g *graph) SmartGraphAttribute() string {
	return g.input.SmartGraphAttribute
}

// MinReplicationFactor returns the minimum replication factor for the graph.
func (g *graph) MinReplicationFactor() int {
	return g.input.MinReplicationFactor
}

// NumberOfShards returns the number of shards for the graph.
func (g *graph) NumberOfShards() int {
	return g.input.NumberOfShards
}

// OrphanCollections returns the orphan collections of the graph.
func (g *graph) OrphanCollections() []string {
	return g.input.OrphanCollections
}

// ReplicationFactor returns the current replication factor.
func (g *graph) ReplicationFactor() int {
	return int(g.input.ReplicationFactor)
}

// WriteConcern returns the write concern setting of the graph.
func (g *graph) WriteConcern() int {
	return g.input.WriteConcern
}

// Remove removes the entire graph.
// If the graph does not exist, a NotFoundError is returned.
func (g *graph) Remove(ctx context.Context) error {
	req, err := g.conn.NewRequest("DELETE", g.relPath())
	if err != nil {
		return WithStack(err)
	}
	applyContextSettings(ctx, req)
	resp, err := g.conn.Do(ctx, req)
	if err != nil {
		return WithStack(err)
	}
	if err := resp.CheckStatus(201, 202); err != nil {
		return WithStack(err)
	}
	return nil
}

func (g *graph) RemoveWithOpts(ctx context.Context, opts *RemoveGraphOptions) error {
	req, err := g.conn.NewRequest("DELETE", g.relPath())
	if err != nil {
		return WithStack(err)
	}

	if opts != nil {
		if opts.DropCollections {
			req.SetQuery("dropCollections", "true")
		}
	}

	applyContextSettings(ctx, req)
	resp, err := g.conn.Do(ctx, req)
	if err != nil {
		return WithStack(err)
	}
	if err := resp.CheckStatus(201, 202); err != nil {
		return WithStack(err)
	}
	return nil
}