Module com.darkcollective.relix.lang.ast
Package com.darkcollective.relix.lang.ast.source

Record Class DatabaseSourceConfig

java.lang.Object
java.lang.Record
com.darkcollective.relix.lang.ast.source.DatabaseSourceConfig
Record Components:
url - the JDBC connection URL; must not be blank
table - the database table or view name; must not be blank
columns - the ordered column specifications; must not be empty
references - the declared column references; may be empty
All Implemented Interfaces:
SourceConfig
public record DatabaseSourceConfig(String url, String table, List<ColumnSpec> columns, List<ColumnReference> references) extends Record implements SourceConfig
Configuration for a database-backed source (JDBC table or view).

Example: 

   source Users from database {
       url:   "${DB_URL}",
       table: "users",
       schema: {
           id:    NUMBER,
           name:  STRING,
           email: STRING
       }
   };

All columns in a database source are implicitly ColumnDirection.OUT; predicate pushdown to SQL WHERE clauses is handled by the execution layer based on column names, not by explicit IN bindings.

The url value may contain ${VAR} environment references.

An optional references: block declares foreign-key style relationships from this source's columns to other relations: 

   references: { customer_id -> Customers.customer_id }

  • Constructor Details

    • DatabaseSourceConfig

      public DatabaseSourceConfig(String url, String table, List<ColumnSpec> columns, List<ColumnReference> references)
      Creates an instance of a DatabaseSourceConfig record class.
      Parameters:
      url - the value for the url record component
      table - the value for the table record component
      columns - the value for the columns record component
      references - the value for the references record component

    • DatabaseSourceConfig

      public DatabaseSourceConfig(String url, String table, List<ColumnSpec> columns)
      Creates a config with no declared references.

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • url

      public String url()
      Returns the value of the url record component.
      Returns:
      the value of the url record component

    • table

      public String table()
      Returns the value of the table record component.
      Returns:
      the value of the table record component

    • columns

      public List<ColumnSpec> columns()
      Returns the value of the columns record component.
      Returns:
      the value of the columns record component

    • references

      public List<ColumnReference> references()
      Returns the value of the references record component.
      Returns:
      the value of the references record component