langchain_community.utilities.cassandra_database
.Tableยถ
- class langchain_community.utilities.cassandra_database.Table[source]ยถ
Bases:
BaseModel
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the input data cannot be parsed to form a valid model.
- param clustering: List[Tuple[str, str]] [Optional]ยถ
- param columns: List[Tuple[str, str]] [Optional]ยถ
- param comment: Optional[str] = Noneยถ
The comment associated with the table.
- param indexes: List[Tuple[str, str, str]] [Optional]ยถ
- param keyspace: str [Required]ยถ
The keyspace in which the table exists.
- param partition: List[str] [Optional]ยถ
- param table_name: str [Required]ยถ
The name of the table.
- as_markdown(include_keyspace: bool = True, header_level: Optional[int] = None) str [source]ยถ
Generates a Markdown representation of the Cassandra table schema, allowing for customizable header levels for the table name section.
- Parameters
include_keyspace (bool) โ If True, includes the keyspace in the output. Defaults to True.
header_level (Optional[int]) โ Specifies the markdown header level for the table name. If None, the table name is included without a header. Defaults to None (no header level).
- Returns
A string in Markdown format detailing the table name (with optional header level), keyspace (optional), comment, columns, partition keys, clustering keys (with optional clustering order), and indexes.
- Return type
str
- classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) Model ยถ
Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if Config.extra = โallowโ was set since it adds all passed values
- Parameters
_fields_set (Optional[SetStr]) โ
values (Any) โ
- Return type
Model
- copy(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, update: Optional[DictStrAny] = None, deep: bool = False) Model ยถ
Duplicate a model, optionally choose which fields to include, exclude and change.
- Parameters
include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) โ fields to include in new model
exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) โ fields to exclude from new model, as with values this takes precedence over include
update (Optional[DictStrAny]) โ values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data
deep (bool) โ set to True to make a deep copy of the model
self (Model) โ
- Returns
new model instance
- Return type
Model
- dict(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) DictStrAny ยถ
Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
- Parameters
include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) โ
exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) โ
by_alias (bool) โ
skip_defaults (Optional[bool]) โ
exclude_unset (bool) โ
exclude_defaults (bool) โ
exclude_none (bool) โ
- Return type
DictStrAny
- classmethod from_database(keyspace: str, table_name: str, db: CassandraDatabase) Table [source]ยถ
- Parameters
keyspace (str) โ
table_name (str) โ
db (CassandraDatabase) โ
- Return type
- classmethod from_orm(obj: Any) Model ยถ
- Parameters
obj (Any) โ
- Return type
Model
- json(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, encoder: Optional[Callable[[Any], Any]] = None, models_as_dict: bool = True, **dumps_kwargs: Any) unicode ยถ
Generate a JSON representation of the model, include and exclude arguments as per dict().
encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().
- Parameters
include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) โ
exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) โ
by_alias (bool) โ
skip_defaults (Optional[bool]) โ
exclude_unset (bool) โ
exclude_defaults (bool) โ
exclude_none (bool) โ
encoder (Optional[Callable[[Any], Any]]) โ
models_as_dict (bool) โ
dumps_kwargs (Any) โ
- Return type
unicode
- classmethod parse_file(path: Union[str, Path], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) Model ยถ
- Parameters
path (Union[str, Path]) โ
content_type (unicode) โ
encoding (unicode) โ
proto (Protocol) โ
allow_pickle (bool) โ
- Return type
Model
- classmethod parse_obj(obj: Any) Model ยถ
- Parameters
obj (Any) โ
- Return type
Model
- classmethod parse_raw(b: Union[str, bytes], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) Model ยถ
- Parameters
b (Union[str, bytes]) โ
content_type (unicode) โ
encoding (unicode) โ
proto (Protocol) โ
allow_pickle (bool) โ
- Return type
Model
- classmethod schema(by_alias: bool = True, ref_template: unicode = '#/definitions/{model}') DictStrAny ยถ
- Parameters
by_alias (bool) โ
ref_template (unicode) โ
- Return type
DictStrAny
- classmethod schema_json(*, by_alias: bool = True, ref_template: unicode = '#/definitions/{model}', **dumps_kwargs: Any) unicode ยถ
- Parameters
by_alias (bool) โ
ref_template (unicode) โ
dumps_kwargs (Any) โ
- Return type
unicode
- classmethod update_forward_refs(**localns: Any) None ยถ
Try to update ForwardRefs on fields based on this Model, globalns and localns.
- Parameters
localns (Any) โ
- Return type
None
- classmethod validate(value: Any) Model ยถ
- Parameters
value (Any) โ
- Return type
Model