graviti.dataframe.sql.container#

The search container and register.

Module Contents#

Classes#

ScalarContainer

The base class for the search scalar container.

ArrayContainer

The base class for the search array container.

SearchContainerRegister

The class decorator to connect portex type and the search array container.
class graviti.dataframe.sql.container.ScalarContainer(expr, schema)[source]#

The base class for the search scalar container.

Parameters

  • expr (_E) – The expression of the search.

  • schema (graviti.portex.PortexType) – The schema of the series.

classmethod from_upper(cls, expr, schema)[source]#

Instantiate a Search object from the upper level.

Parameters

  • expr (_E) – The expression of the search.

  • schema (graviti.portex.PortexType) – The schema of the series.

  • cls (Type[_S]) –

Returns

The loaded object.

Return type

_S

class graviti.dataframe.sql.container.ArrayContainer(expr, schema, upper_expr)[source]#

The base class for the search array container.

Parameters

  • expr (_E) – The expression of the search.

  • schema (graviti.portex.PortexType) – The schema of the series.

  • upper_expr (_E) – The expression of the search.

classmethod from_upper(cls, expr, schema)[source]#

Instantiate a Search object from the upper level.

Parameters

  • expr (_E) – The upper expression of the search.

  • schema (graviti.portex.PortexType) – The schema of the series.

Returns

The loaded object.

Return type

ArrayContainer

class graviti.dataframe.sql.container.SearchContainerRegister(*portex_types)[source]#

The class decorator to connect portex type and the search array container.

Parameters

portex_types (Type[graviti.portex.PortexType]) – The portex types needs to be connected.