Olifant - Repositories

From Okapi Framework
Jump to navigation Jump to search

Any TM you open in Olifant is stored in a repository. You have several types of repository to work with:

Repository Selection

This dialog box allows you to select the repository to use.

Default local repository — Select this option to use the default repository on your machine. It is named defaultOlifantTMRepository and located in the Olifant sub-directory of your home directory. This type of repository cannot be used by several users at the same time.

This repository is automatically created if it does not exists yet when you select it.

Other local or network repository — Select this option to use a repository of your choice located on your machine or on any file system you can access through your network connection. This type of repository cannot be used by several users at the same time.

You must specify the repository to use. If you enter a repository that does not exist it will be automatically created.

H2 server-based repository — Select this option to use a H2 server-based repository. The server can be running on a remote machine or on your own. This type of repository can be used by several users at the same time.

You must specify the sever host and the name of the repository to use in the format: <hostURL>[:<port>]/<repositoryName>. For example: localhost/myRepo will open a repository named myRepo located in the base directory of the H2 server running on your machine. Another example: 123.456.78.9:9092/someRepo will open the repository named someRepo located in the base directory of the H2 server running at the IP address 123.456.78.9 on port 9092.

Note that the repositories must exists already. You can create them by running Olifant on the server machine and using the Other local or network repository option.

MongoDB server-based repository — Select this option to use a MongoDB server-based repository. The server can be running on a remote machine or on your own. This type of repository can be used by several users at the same time.

You must specify the name of the repository to use, and optionally the server host in the format: [<hostURL>[:<port>]/]<repositoryName>. For example: localhost/myRepo will open a repository named myRepo located on the MongoDB database running on your machine.

Memory-based repository — Select this option to use a virtual repository that is stored in memory rather than a file. It works exactly the same, except that it is not a persistent repository. All the data in this repository are cleared from memory when you close it. This repository can be useful to work with a relatively small set of TMs that you will import into the repository and then export before closing the repository.

When starting Olifant, open automatically the last repository used — Set this option to automatically open the last repository that was used when you start a new session with Olifant.

The H2 Database

The H2 database is a powerful open-source and cross-platform SQL database that works well with medium size data set (5 o 10 millions entries per TM). The engine is provided along with the Olifant installation, there is no need to download it or set it up separately.

If you want to use the H2 server mode, when starting the server you must specify the location of your repositories as the base repository. You also need to specify that the database can be accessed by different users. For example, assuming you want to run the H2 server on a Windows machine and have the repositories stored in C:\OlifantData you would run:

java -cp "h2-1.3.158.jar;" org.h2.tools.Server -tcp -tcpAllowOthers -ifExists -baseDir C:\OlifantData

The MongoDB Database

The MongoDB database is a powerful open-source and cross-platform non-SQL database designed to work with very large data sets, possibly clustered over several machines.

The MongoDB server is not provided with Olifant. It can be downloaded for free and installed easily on various platforms.

When starting the MongoDB server, make sure to specify the path of the directory of your repository:

mongod --dbpath C:\MyRepositories\mongodb