mps.cache.control

Create a persistence service controller object

Starting in a future release, Redis™ will no longer ship with MATLAB^® Production Server™ and MATLAB Compiler SDK™. Redis supports the data persistence functionality in these products. Provide your own Redis persistence service instead. Affected functions include start, stop, and restart.

Syntax

ctrl = mps.cache.control(connectionName,Provider,'Port',num)

ctrl = mps.cache.control(connectionName,Provider,'Folder',folderPath)

Description

ctrl = mps.cache.control(connectionName,Provider,'Port',num) creates a persistence service controller object using a connection to a persistence service specified by connectionName, a persistence provider specified by Provider, and a port number num for the service.

You cannot compile and deploy this function on the server. This function is available only for testing.

ctrl = mps.cache.control(connectionName,Provider,'Folder',folderPath) creates a persistence service controller object that uses a folder specified by folderPath as a database.

Use this syntax when you want to use MATLAB as a persistence provider for testing purposes.

You cannot compile and deploy this function on the server. This function is available only for testing.

Examples

Create a Redis Service Controller

ctrl = mps.cache.control('myRedisConnection','Redis','Port',4519)

ctrl = 

  Controller with properties:

    ActiveConnection: False
       ManageService: Unknown
                Host: 'localhost'
                Port: 4519
          Operations: "read | write | create | update"
        ProviderName: 'Redis'
      ConnectionName: 'myRedisConnection'

Create a MATLAB Service Controller

mctrl = mps.cache.control('myMATFileConnection','MatlabTest','Folder','c:\tmp') 

mctrl = 

  Controller with properties:

    ActiveConnection: False
       ManageService: Unknown
              Folder: 'c:\tmp'
          Operations: "read | write | create | update"
        ProviderName: 'MatlabTest'
      ConnectionName: 'myMATFileConnection'

Input Arguments

connectionName — Name of the connection

character vector | string

Name of the connection to the persistence service, specified as a character vector.

The connectionName links a MATLAB session to a persistence service.

Example: 'myRedisConnection'

Provider — Name of the persistence provider

'Redis' | 'MatlabTest'

Name of the persistence provider, specified as a character vector.

You can use MATLAB as a persistence provider for testing purposes. If you use MATLAB as a persistence provider, specify the provider name as 'MatlabTest'.

Example: 'Redis'

Example: 'MatlabTest'

num — Port number

positive scalar

Port number for the persistence service.

Example: 'Port', 4519

folderPath — Storage folder path

character vector

Storage folder path, specified as a character vector.

Specify this input only when you want to use MATLAB as a persistence provider for testing purposes. A folder specified by folderPath serves as a database.

Example: 'Folder','c:\tmp'

Output Arguments

ctrl — Persistence provider service controller object

mps.cache.Controller object

Persistence provider service controller returned as a mps.cache.Controller object.

Version History

Introduced in R2018b