api

package

v1.1.0 Latest Latest Go to latest Published: Nov 3, 2022 License: MIT Imports: 10 Imported by: 0

Documentation ¶

Index ¶

func OverrideMetadataTable(dims []string, mt *cantabular.MetadataTableQuery) error
type CantMetaAPI
type CantabularMetadataExtractorAPI
- func Setup(ctx context.Context, r *mux.Router, config *config.Config, c CantMetaAPI) *CantabularMetadataExtractorAPI
- func (api *CantabularMetadataExtractorAPI) GetMetadataDataset(ctx context.Context, cantDataset string, dimensions []string, lang string) (*cantabular.MetadataDatasetQuery, error)
- func (api *CantabularMetadataExtractorAPI) GetMetadataTable(ctx context.Context, cantDataset string, lang string) (*cantabular.MetadataTableQuery, []string, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func OverrideMetadataTable ¶

func OverrideMetadataTable(dims []string, mt *cantabular.MetadataTableQuery) error

OverrideMetadataTable modifies the dimensions and results of the MetadataTableQuery to always use "ltla". This is the geocode used in the recipe and we need to ensure the result from the metadata server matches the recipe. This ensures also the following GetMetadataDataset uses "ltla".

Types ¶

type CantMetaAPI ¶ added in v1.1.0

type CantMetaAPI interface {
	MetadataDatasetQuery(ctx context.Context, req cantabular.MetadataDatasetQueryRequest) (*cantabular.MetadataDatasetQuery, error)
	MetadataTableQuery(ctx context.Context, req cantabular.MetadataTableQueryRequest) (*cantabular.MetadataTableQuery, error)
}

cantExtAPI

type CantabularMetadataExtractorAPI ¶

type CantabularMetadataExtractorAPI struct {
	Router      *mux.Router
	CantMetaAPI CantMetaAPI
	Cfg         *config.Config
}

func Setup ¶

func Setup(ctx context.Context, r *mux.Router, config *config.Config, c CantMetaAPI) *CantabularMetadataExtractorAPI

Setup function sets up the api and returns an api

func (*CantabularMetadataExtractorAPI) GetMetadataDataset ¶

func (api *CantabularMetadataExtractorAPI) GetMetadataDataset(ctx context.Context, cantDataset string, dimensions []string, lang string) (*cantabular.MetadataDatasetQuery, error)

func (*CantabularMetadataExtractorAPI) GetMetadataTable ¶

func (api *CantabularMetadataExtractorAPI) GetMetadataTable(ctx context.Context, cantDataset string, lang string) (*cantabular.MetadataTableQuery, []string, error)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
mock

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL