docarray.array.storage.sqlite package

Submodules

• docarray.array.storage.sqlite.backend module
  • SqliteConfig
    • SqliteConfig.connection
    • SqliteConfig.table_name
    • SqliteConfig.list_like
    • SqliteConfig.serialize_config
    • SqliteConfig.conn_config
    • SqliteConfig.journal_mode
    • SqliteConfig.synchronous
    • SqliteConfig.root_id
  • BackendMixin
    • BackendMixin.schema_version
    • BackendMixin.TYPE_MAP
• docarray.array.storage.sqlite.getsetdel module
  • GetSetDelMixin
    • GetSetDelMixin.sync()
• docarray.array.storage.sqlite.helper module
  • initialize_table()
• docarray.array.storage.sqlite.seqlike module
  • SequenceLikeMixin
    • SequenceLikeMixin.insert()
    • SequenceLikeMixin.append()
    • SequenceLikeMixin.clear()
    • SequenceLikeMixin.count()
    • SequenceLikeMixin.extend()
    • SequenceLikeMixin.index()
    • SequenceLikeMixin.pop()
    • SequenceLikeMixin.remove()
    • SequenceLikeMixin.reverse()

Module contents

class docarray.array.storage.sqlite.StorageMixins(*args, **kwds)

Bases: FindMixin, BackendMixin, GetSetDelMixin, SequenceLikeMixin, ABC

append(value, **kwargs)

Append doc to the end of the array.

Parameters:

value (Document) – The doc needs to be appended.

clear()

Clear the data of DocumentArray

count(value) → integer -- return number of occurrences of value

extend(values, **kwargs)

S.extend(iterable) – extend sequence by appending elements from the iterable

Return type:

None

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

insert(index, value)

Insert doc at index.

Parameters:

• index (int) – Position of the insertion.

• value (Document) – The doc needs to be inserted.

pop([index]) → item -- remove and return item at index (default last).

Raise IndexError if list is empty or index is out of range.

remove(value)

S.remove(value) – remove first occurrence of value. Raise ValueError if the value is not present.

reverse()

S.reverse() – reverse IN PLACE

schema_version = '0'

sync()

TYPE_MAP: Dict[str, TypeMap]

class docarray.array.storage.sqlite.SqliteConfig(connection=None, table_name=None, list_like=True, serialize_config=<factory>, conn_config=<factory>, journal_mode='WAL', synchronous='OFF', root_id=True)

Bases: object

connection: Optional[Union[str, Connection]] = None

table_name: Optional[str] = None

list_like: bool = True

serialize_config: Dict

conn_config: Dict

journal_mode: str = 'WAL'

synchronous: str = 'OFF'

root_id: bool = True