chifi database server
note: It is not recommended to use ChiDB (in production) as of its current version. The project still requires a bit more work for production use, and this version is primarily expiremental and being used for testing.
This documentation remains partial and is incomplete.
The first step in setting up a database server is, of course, adding the package; this package is not in the registry and may never be, so it will be added via URL:
using Pkg
Pkg.add(url = "https://github.com/ChifiSource/ChiDB.jl")
# optional: add Unstable for latest, sometimes broken updates.
Pkg.add(url = "https://github.com/ChifiSource/ChiDB.jl", rev = "Unstable")
Once we have ChiDB, we use start to start our database server. By default, the server will start on port 8005. This start function takes a path (String) and optionally a Toolips.IP4.
using ChiDB; ChiDB.start(pwd())
ChiDB.start(pwd(), "127.0.0.1":7010)
On our first start in a new directory, a new db directory will be created. None of the files within this directory are meant to be viewed or edited manually. We will also get the admin's login information. Save it. There is no way to view this again without deleting the db directory and starting over. Note that, in that event, the schema is still retained. CryptString values will not be recoverable, however, and users will be deleted. The password can be changed after login using queries. Other users may also be created, but have limited permissions with certain commands — specifically those which edit user accounts.