schema

README

Schema Retrieval Package

This is the package used by the schema service to retrieve and convert the schema.

Retriever Interface

Any new database schema retriever needs to implement the Retriever interface found in interface.go.

Creating a Schema Retrieval Service

import "git.science.uu.nl/datastrophe/schema-retrieval/arangodb"

arangodbService := arangodb.NewService()

Retrieving the Schema

schema, err := arangodbService.RetrieveSchema(databaseInfo entity.DatabaseInfo, userID string, databaseName string)

Documentation

Index

• type Retriever
  • func GetRetriever(engine string) Retriever

Types

type Retriever

type Retriever interface {
	RetrieveSchema(databaseInfo *models.DBConnectionModel, userID string) (*schemaEntity.JSONReturnFormat, error)
	RetrieveSchemaStats(databaseInfo *models.DBConnectionModel, userID string) (*schemaEntity.SchemaStats, error)
}

Interface for a database schema retriever

func GetRetriever

func GetRetriever(engine string) Retriever