MetaCodeContext#

class swordfish._connection.MetaCodeContext(impl)#

Used for generating meta code.

Examples

>>> with sf.meta_code() as m:
...     code = m.var("a")
>>> code
MetaCode(< a >)
Parameters:

impl (MetaCodeContextImpl)

var(name)#

Generates meta code representing a variable by its name.

Parameters:

name (str) – The name of the variable.

Returns:

The generated meta code.

Return type:

MetaCode

Examples

>>> with sf.meta_code() as m:
...     code = m.var("a")
>>> code
MetaCode(< a >)
const(obj)#

Generates meta code representing a Constant.

Parameters:

obj (Constant) – The constant object.

Returns:

The generated meta code.

Return type:

MetaCode

Examples

>>> with sf.meta_code():
...     code = x.const(2)
>>> code
MetaCode(< 2 >)
col(name, *, qualifier=None)#

Generates meta code for a column.

Parameters:
  • name (str) – The name of the column.

  • qualifier (str, optional) – The qualifier for the column. Defaults to None.

Returns:

The generated meta code.

Return type:

MetaCode

Examples

>>> with sf.meta_code():
...     code = x.col("id", qualifier="t")
>>> code
MetaCode(< t.id >)
col_alias(obj, name)#

Generates meta code for assigning an alias to a column or aliases to columns.

Parameters:
  • obj (MetaCode) – The original meta code for the column.

  • name (Union[str, List[str]]) – The alias name(s).

Returns:

The meta code with the column alias applied.

Return type:

MetaCode

Examples

>>> with sf.meta_code():
...     code = x.col_alias(x.col("id"), "col1")
>>> code
MetaCode(< id as col1 >)
parse(expression)#

Parses a string expression into corresponding meta code.

Parameters:

expression (str) – The expression to parse into meta code.

Returns:

The parsed meta code corresponding to the expression.

Return type:

MetaCode

Examples

>>> with sf.meta_code():
...     code = x.parse("a == 5")
>>> code
MetaCode(< a == 5 >)
call(func, *args)#
Return type:

MetaCode

make_table_joiner(func, *args)#
Return type:

MetaCode

property case_#