tuple

Documentation

Overview

Package tuple contains commands that interact directly with stored relationship tuples.

Index

• Constants
• Variables
• func ExactArgsOrFlag(n int, flag string) cobra.PositionalArgs
• type ImportResponse
  • func ImportTuples(fgaClient client.SdkClient, body client.ClientWriteRequest, ...) (*ImportResponse, error)
• type ImportStats

Constants

const (
	// MaxTuplesPerWrite Limit the tuples in a single batch.
	MaxTuplesPerWrite = 1

	// MaxParallelRequests Limit the parallel writes to the API.
	MaxParallelRequests = 10
)

Variables

var MaxReadChangesPagesLength = 20

MaxReadChangesPagesLength Limit the changes so that we are not paginating indefinitely.

var MaxReadPagesLength = 20

MaxReadPagesLength Limit the tuples so that we are not paginating indefinitely.

var TupleCmd = &cobra.Command{
	Use:   "tuple",
	Short: "Interact with Relationship Tuples",
	Long:  "Read, write, delete, import and listen to changes in relationship tuples in a store.",
}

TupleCmd represents the tuple command.

Functions

func ExactArgsOrFlag

func ExactArgsOrFlag(n int, flag string) cobra.PositionalArgs

Types

type ImportResponse

type ImportResponse struct {
	Successful []client.ClientTupleKey `json:"successful"`
	Failed     []failedWriteResponse   `json:"failed"`
}

func ImportTuples

func ImportTuples(
	fgaClient client.SdkClient,
	body client.ClientWriteRequest,
	maxTuplesPerWrite int32,
	maxParallelRequests int32,
) (*ImportResponse, error)

ImportTuples receives a client.ClientWriteRequest and imports the tuples to the store. It can be used to import either writes or deletes. It returns a pointer to an ImportResponse and an error. The ImportResponse contains the tuples that were successfully imported and the tuples that failed to be imported. Deletes and writes are put together in the same ImportResponse.

type ImportStats

type ImportStats struct {
	TotalTuples      int
	SuccessfulTuples int
	FailedTuples     int
}