IdentifiableJsonSqlServerPersistence

Implements: IdentifiableSqlServerPersistence, IIdentifiable

Description

The IdentifiableJsonSqlServerPersistence class allows you to create persistence components that store data in an SQLServer database in JSON or JSONB fields and implement a number of CRUD operations over data items with unique ids.

Important points

• The data items must implement the IIdentifiable interface.
• In basic scenarios child classes shall only override get_page_by_filter, get_list_by_filter or delete_by_filter operations with an specific filter function.
• All other operations can be used out of the box.
• In complex scenarios child classes can implement additional operations by accessing self._collection and self._model properties.

Configuration parameters

• table: (optional) SQLServer table name
• schema: (optional) SQLServer table name
  connection(s):
• discovery_key: (optional) key to retrieve the connection from IDiscovery
• host: host name or IP address
• port: port number (default: 27017)
• uri: resource URI or connection string with all parameters in it
  credential(s):
• store_key: (optional) key to retrieve the credentials from ICredentialStore
• username: (optional) username
• password: (optional) user’s password
  options:
• connect_timeout: (optional) number of milliseconds to wait before timing out when connecting a new client (default: 0)
• idle_timeout: (optional) number of milliseconds a client must sit idle in the pool and not be checked out (default: 10000)
• max_pool_size: (optional) maximum number of clients the pool can contain (default: 10)

References

• *:logger:*:*:1.0 - (optional) ILogger components to pass log messages
• *:discovery:*:*:1.0 - (optional) IDiscovery services
• *:credential-store:*:*:1.0 - (optional) ICredentialStore to resolve credentials

Constructors

Creates a new instance of the persistence component.

IdentifiableJsonSqlServerPersistence(table_name: str = None, schema_name: str = None)

• table_name: str - (optional) a table name.
• schema_name: str - (optional) a schema name.

Instance methods

_convert_from_public

Converts an object value from public to internal format.

_convert_from_public(value: Any): Any

• value: Any - object in public format to convert.
• returns: Any - converted object in internal format.

_convert_from_public_partial

Converts the given object from the public partial format.

_convert_from_public_partial(value: Any): Any

• value: Any - the object to convert from the public partial format.
• returns: Any - the initial object.

_convert_to_public

Converts object value from internal to public format.

_convert_to_public(value: Any): Any

• value: Any - an object in internal format to convert.
• returns: Any - converted object in public format.

_ensure_table

Adds DML statement to automatically create a JSON(B) table

_ensure_table(id_type: str = ‘VARCHAR(32)’, data_type: str = ‘NVARCHAR(MAX)')

• id_type: str - type of the id column (default: VARCHAR(32))
• data_type: str - type of the data column (default: NVARCHAR(MAX))

update_partially

Updates only few selected fields in a data item.

update_partially(correlation_id: Optional[str], id: Any, data: AnyValueMap): Optional[T]

• correlation_id: Optional[str] - (optional) transaction id used to trace execution through a call chain.
• id: Any - id of data item to be updated.
• data: AnyValueMap - map with fields to be updated.
• return: Optional[T] - updated item

Examples

class MySqlServerPersistence(IdentifiableJsonSqlServerPersistence):

    def __init__(self):
        super(MySqlServerPersistence, self).__init__("mydata", MyDataSqlServerSchema())

    def __compose_filter(self, filter):
        filter = filter or FilterParams()
        criteria = []
        name = filter.get_as_nullable_string('name')
        if name:
            criteria.append({'name': name})
        return {'$and': criteria} if len(criteria) > 0 else None

    def get_page_by_filter(self, correlation_id, filter, paging):
        return super().get_page_by_filter(correlation_id, self.__compose_filter(filter), paging, None, None)

persistence = MySqlServerPersistence()
persistence.configure(ConfigParams.from_tuples(
    "host", "localhost",
    "port", 27017
))

persistence.open('123')
persistence.create('123', {'id': "1", 'name': "ABC"})
page = persistence.get_page_by_filter('123', FilterParams.from_tuples('name', 'ABC'), None)

print(page.data) # Result: { id: "1", name: "ABC" }
persistence.delete_by_id("123", "1")
# ...