Package org.apache.druid.sql.calcite.schema

Class DruidSchemaCatalog

java.lang.Object

org.apache.druid.sql.calcite.schema.DruidSchemaCatalog

public class DruidSchemaCatalog
extends Object

The Druid 'catalog', containing information about all Druid schemas which are available. This packages both the 'root level' Calcite SchemaPlus and a map of the NamedSchema which were used to populate it, keyed by NamedSchema.getSchemaName(). The rootSchema is a top level Calcite schema, which contains all NamedSchema.getSchema() and InformationSchema added as sub-schemas, and this class provides convenience methods to do things like fetch a specific SchemaPlus by name or list the set of all schemas available, and is used during query planning and execution. namedSchemas contains all NamedSchema, which should be everything except InformationSchema. These are used primarily for getResourceType(String, String), which given the name of a table or function that belongs to some NamedSchema, lookup the most appropriate value to use for Resource.getType() to use for authorization.

Constructor Summary

Constructors

Constructor	Description
DruidSchemaCatalog(org.apache.calcite.schema.SchemaPlus rootSchema, Map<String,NamedSchema> schemas)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
NamedSchema	getNamedSchema(String schemaName)	Get a NamedSchema by NamedSchema.getSchemaName()
Map<String,NamedSchema>	getNamedSchemas()	Get all NamedSchema which belong to the Druid catalog
String	getResourceType(String schema, String resourceName)	Given the name of a NamedSchema and the name of a table or function that belongs to that schema, return the appropriate value to use for Resource.getType() during authorization
org.apache.calcite.schema.SchemaPlus	getRootSchema()	Root calcite schema, used to plan and execute queries
org.apache.calcite.schema.SchemaPlus	getSubSchema(String name)	Get a specific SchemaPlus by NamedSchema.getSchemaName()
Set<String>	getSubSchemaNames()	Get all sub-schemas defined on rootSchema
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DruidSchemaCatalog

public DruidSchemaCatalog(org.apache.calcite.schema.SchemaPlus rootSchema,
 Map<String,NamedSchema> schemas)

Method Details

getRootSchema

public org.apache.calcite.schema.SchemaPlus getRootSchema()

Root calcite schema, used to plan and execute queries

getNamedSchemas

public Map<String,NamedSchema> getNamedSchemas()

Get all NamedSchema which belong to the Druid catalog

getNamedSchema

public NamedSchema getNamedSchema(String schemaName)

Get a NamedSchema by NamedSchema.getSchemaName()

getSubSchema

public org.apache.calcite.schema.SchemaPlus getSubSchema(String name)

Get a specific SchemaPlus by NamedSchema.getSchemaName()

getSubSchemaNames

public Set<String> getSubSchemaNames()

Get all sub-schemas defined on rootSchema

getResourceType

@Nullable
public String getResourceType(String schema,
 String resourceName)

Given the name of a NamedSchema and the name of a table or function that belongs to that schema, return the appropriate value to use for Resource.getType() during authorization

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object