Package org.apache.druid.catalog.model.table

Class LocalInputSourceDefn

java.lang.Object
org.apache.druid.catalog.model.table.BaseInputSourceDefn
org.apache.druid.catalog.model.table.FormattedInputSourceDefn
org.apache.druid.catalog.model.table.LocalInputSourceDefn
All Implemented Interfaces:
InputSourceDefn
public class LocalInputSourceDefn extends FormattedInputSourceDefn
Definition for a LocalInputSource.

  • Field Details

  • Constructor Details

    • LocalInputSourceDefn

      public LocalInputSourceDefn()

  • Method Details

    • typeValue

      public String typeValue()
      Description copied from interface: InputSourceDefn
      Type value for this format: same as the type string used in the serialized JSON for this input source. Used as the key for this definition within the table registry, and associates the serialized JSON with the corresponding input source definition.

    • inputSourceClass

      protected Class<? extends InputSource> inputSourceClass()
      Description copied from class: BaseInputSourceDefn
      Overridden by each subclass to return the input source class to be used for JSON conversions.
      Specified by:
      inputSourceClass in class BaseInputSourceDefn

    • validate

      public void validate(ResolvedExternalTable table)
      Description copied from interface: InputSourceDefn
      Given a external table catalog spec, with the JSON input source and format properties parsed to generic Java maps, validate that the properties are valid prior to saving the spec into the catalog.
      Specified by:
      validate in interface InputSourceDefn
      Overrides:
      validate in class FormattedInputSourceDefn
      Parameters:
      table - a catalog table spec with the input source and input format properties parsed into generic Java maps

    • adHocTableFnParameters

      protected List<TableFunction.ParameterDefn> adHocTableFnParameters()
      Description copied from class: FormattedInputSourceDefn
      Overridden by subclasses to provide the list of table function parameters for this specific input format. This list is combined with parameters for input formats. The method is called only once per run.
      Specified by:
      adHocTableFnParameters in class FormattedInputSourceDefn

    • convertArgsToSourceMap

      protected void convertArgsToSourceMap(Map<String,Object> jsonMap, Map<String,Object> args)
      Description copied from class: BaseInputSourceDefn
      Convert SQL arguments to the corresponding "generic JSON" form in the given map. The map will then be adjusted and converted to the actual input source.
      Specified by:
      convertArgsToSourceMap in class BaseInputSourceDefn

    • partialTableFn

      public TableFunction partialTableFn(ResolvedExternalTable table)
      Description copied from interface: InputSourceDefn
      Provide a definition for a SQL table function that completes a partial table spec from the catalog. Used when the spec represents a "partial table" or a "connection". The function provides parameters needed to complete the table (typically the set of input files, objects, etc.) If the catalog table spec does not provide a format, and this input source requires a format, then the parameters also include parameters for all supported input formats, same as for InputSourceDefn.adHocTableFn().
      Parameters:
      table - a catalog table spec with the input source and input format properties parsed into generic Java maps
      Returns:
      a fully-defined external table to be handed off to the Calcite planner.

    • convertCompletedTable

      protected ExternalTableSpec convertCompletedTable(ResolvedExternalTable table, Map<String,Object> args, List<ColumnSpec> columns)
      Description copied from class: BaseInputSourceDefn
      Complete a partial table using the table function arguments and columns provided. The arguments match the set of parameters used for the function. The columns are provided if the SQL included an EXTENDS clause: the implementation should decide if columns are required (or allowed) depending on whether the partial spec already defines columns.
      Specified by:
      convertCompletedTable in class BaseInputSourceDefn
      Parameters:
      table - the partial table spec, with input source and format parsed into a generic Java map
      args - the argument values provided in the SQL table function call. The arguments use the Java types defined in the parameter definitions.
      columns - the set of columns (if any) from the SQL EXTEND clause
      Returns:
      an external table spec which Calcite can consume

    • auditInputSource

      protected void auditInputSource(Map<String,Object> jsonMap)
      Description copied from class: BaseInputSourceDefn
      Optional step to audit or adjust the input source properties prior to conversion via Jackson. Changes are made directly in the jsonMap.
      Overrides:
      auditInputSource in class BaseInputSourceDefn

    • convertTable

      public ExternalTableSpec convertTable(ResolvedExternalTable table)
      Description copied from interface: InputSourceDefn
      Convert a complete (that is, fully-defined) table spec to an external table spec. Used when SQL references the catalog table directly by name in the FROM clause without using a table function.
      Specified by:
      convertTable in interface InputSourceDefn
      Overrides:
      convertTable in class BaseInputSourceDefn
      Returns:
      a fully-defined external table to be handed off to the Calcite planner.