The MicroStream Storage isn't a typical database server with administrative tooling and stuff like that. It is just a Java library which runs embedded in your application. The storage data layer, per default the file system, contains the serialized and persisted data. But it is not really accessible, or more precise, human-readable. Nor do we provide a query language to access the storage data.

The Java objects, which reside in memory, are easy to inspect and traverse, e.g. with a debugger.

But for various purposes, like monitoring, the requirement to read the actual stored data has come up.

Since version 3.0 a REST interface for the storage data is included. It enables you to access the data via REST calls or a convenient user interface.

It is made up of the following modules:

Root

GET [instance-name]/root

Returns the name and object id of the current storage root element.

Object

GET [instance-name]/object/:objectid

Returns description and values of a distinct object.

Path Parameters

Query Parameters

Type Dictionary

GET [instance-name]/dictionary

The type dictionary as plain text.

Statistics

GET [instance-name]/maintenance/filesStatistics

Statistics of the used storage files and channels.

Based on the REST API we provide a client, which serves a convenient web user interface to browse through the storage data.

It is a runnable jar which starts a simple web server which then can be accessed by a browser of your choice.

To download it use maven

or this direct link:

Start the client. The port parameter is optional, default port is 8080.

Now you can browse through the data of the storage:

Or view the statistics:

REST Service

First of all we have to connect a storage to a REST service.

Just add the REST service implementation to your dependencies, the logger is optional.

<repositories>
    <repository>
        <id>microstream-releases</id>
        <url>https://repo.microstream.one/repository/maven-public/</url>
    </repository>
</repositories>
<dependencies>
    <dependency>
        <groupId>one.microstream</groupId>
        <artifactId>storage.restservice.sparkjava</artifactId>
        <version>04.00.00-MS-GA</version>
    </dependency>
		<dependency>
			<groupId>org.slf4j</groupId>
			<artifactId>slf4j-simple</artifactId>
			<version>1.7.30</version>
		</dependency>
</dependencies>

Now use the resolver to connect the service to a storage, start it, and you're good to go.

EmbeddedStorageManager storage = EmbeddedStorage.start();
if(storage.root() == null)
{
		storage.setRoot(new Object[] {
				LocalDate.now(),
				X.List("a", "b", "c"),
				1337
		});
		storage.storeRoot();
}

StorageRestService service = StorageRestServiceResolver.resolve(storage);
service.start();

1) An example storage manager 12) Create the REST service, 13) and start it.

That's all you have to do to open the REST endpoints to access the storage data.

The base URL of the opened endpoints is per default: http://localhost:4567/microstream/

Configuration

If you want to change the default port (4567) or instance name (microstream) it can be done by using the rest service implementation directly. The spark service can then be customized by your liking.

StorageRestServiceSparkJava service = StorageRestServiceSparkJava.New(storage);
service.setSparkService(
		Service.ignite().port(80)
);
service.setInstanceName("my-name");

This will change the base URL to http://localhost/my-name/