data_source

Documentation

Overview

Package data_source provides the tooling to build the Raito data source import file. Simply use the NewDataSourceFileCreator function by passing in the config coming from the CLI to create the necessary file(s). The returned DataSourceFileCreator can then be used (using the AddDataObjects function) to write DataObjects to the file. Make sure to call the Close function on the creator at the end (tip: use defer).

Index

• Constants
• type DataObject
• type DataObjectReference
• type DataObjectType
• type DataObjectTypePermission
• type DataSourceDetails
  • func (d *DataSourceDetails) SetDescription(desc string)
  • func (d *DataSourceDetails) SetFullname(name string)
  • func (d *DataSourceDetails) SetName(name string)
• type DataSourceFileCreator
  • func NewDataSourceFileCreator(config *DataSourceSyncConfig) (DataSourceFileCreator, error)
• type DataSourceSyncConfig
• type DataSourceSyncResult
• type DataSourceSyncer
• type DataSourceSyncerPlugin
  • func (DataSourceSyncerPlugin) Client(b *plugin.MuxBroker, c *rpc.Client) (interface{}, error)
  • func (p *DataSourceSyncerPlugin) Server(*plugin.MuxBroker) (interface{}, error)
• type MetaData

Constants

const (
	/*
		Data Source features
	*/
	ColumnMasking   = "columnMasking"
	RowFiltering    = "rowFiltering"
	ColumnFiltering = "columnFiltering"

	/*
		The list of standard Data Object Types
	*/
	Datasource = "datasource"
	Database   = "database"
	Schema     = "schema"
	Table      = "table"
	View       = "view"
	Column     = "column"
	Dataset    = "dataset"

	/*
		The list of global permissions
	*/
	Write = "write"
	Read  = "read"
)

const DataSourceSyncerName = "dataSourceSyncer"

DataSourceSyncerName constant should not be used directly when implementing plugins. It's the registration name for the data source syncer plugin, used by the CLI and the cli-plugin-base library (RegisterPlugins function) to register the plugins.

Types

type DataObject

type DataObject struct {
	ExternalId       string                 `json:"externalId"`
	Name             string                 `json:"name"`
	FullName         string                 `json:"fullName"`
	Type             string                 `json:"type"`
	Description      string                 `json:"description"`
	ParentExternalId string                 `json:"parentExternalId"`
	Tags             map[string]interface{} `json:"tags"`
}

DataObject represents a data object in the format that is suitable to be imported into a Raito data source.

type DataObjectReference

type DataObjectReference struct {
	FullName string `json:"fullName" yaml:"fullName"`
	Type     string `json:"type" yaml:"type"`
}

DataObjectReference represents the reference to a DataObject suitable for e.g. defining the What in Access Provider import

type DataObjectType

type DataObjectType struct {
	Name        string                     `json:"name"`
	Type        string                     `json:"type"`
	Label       string                     `json:"label"`
	Icon        string                     `json:"icon"`
	Permissions []DataObjectTypePermission `json:"permissions"`
	Children    []string                   `json:"children"`
}

type DataObjectTypePermission

type DataObjectTypePermission struct {
	Permission        string   `json:"permission"`
	GlobalPermissions []string `json:"globalPermissions,omitempty"`
	Description       string   `json:"description"`
}

type DataSourceDetails

type DataSourceDetails struct {
	// contains filtered or unexported fields
}

DataSourceDetails is a helper to abstract this from the plugin and just expose some setters. The import file creator then automatically prepends the import file with this DataObject

func (*DataSourceDetails) SetDescription

func (d *DataSourceDetails) SetDescription(desc string)

func (*DataSourceDetails) SetFullname

func (d *DataSourceDetails) SetFullname(name string)

func (*DataSourceDetails) SetName

func (d *DataSourceDetails) SetName(name string)

type DataSourceFileCreator

type DataSourceFileCreator interface {
	AddDataObjects(dataObjects []DataObject) error
	Close()
	GetDataObjectCount() int
	GetDataSourceDetails() *DataSourceDetails
}

DataSourceFileCreator describes the interface for easily creating the data object import files to be imported by the Raito CLI. Use GetDataSourceDetails() to access DataSourceDetails setters like SetAvailablePermission()

func NewDataSourceFileCreator

func NewDataSourceFileCreator(config *DataSourceSyncConfig) (DataSourceFileCreator, error)

NewDataSourceFileCreator creates a new DataSourceFileCreator based on the configuration coming from the Raito CLI.

type DataSourceSyncConfig

type DataSourceSyncConfig struct {
	config.ConfigMap
	TargetFile   string
	DataSourceId string
}

DataSourceSyncConfig represents the configuration that is passed from the CLI to the DataAccessSyncer plugin interface. It contains all the necessary configuration parameters for the plugin to function.

type DataSourceSyncResult

type DataSourceSyncResult struct {
	Error *error2.ErrorResult
}

DataSourceSyncResult represents the result from the data source sync process. A potential error is also modeled in here so specific errors remain intact when passed over RPC.

type DataSourceSyncer

type DataSourceSyncer interface {
	SyncDataSource(config *DataSourceSyncConfig) DataSourceSyncResult
	GetMetaData() MetaData
}

DataSourceSyncer interface needs to be implemented by any plugin that wants to import data objects into a Raito data source.

type DataSourceSyncerPlugin

type DataSourceSyncerPlugin struct {
	Impl DataSourceSyncer
}

DataSourceSyncerPlugin is used on the server (CLI) and client (plugin) side to integrate with the plugin system. A plugin should not be using this directly, but instead depend on the cli-plugin-base library to register the plugins.

func (DataSourceSyncerPlugin) Client

func (DataSourceSyncerPlugin) Client(b *plugin.MuxBroker, c *rpc.Client) (interface{}, error)

func (*DataSourceSyncerPlugin) Server

func (p *DataSourceSyncerPlugin) Server(*plugin.MuxBroker) (interface{}, error)

type MetaData

type MetaData struct {
	DataObjectTypes   []DataObjectType `json:"dataObjectTypes"`
	SupportedFeatures []string         `json:"supportedFeatures"`
	Type              string           `json:"type"`
	Icon              string           `json:"icon"`
}