A Persistence Framework for Scala and NoSQL

View project on GitHub

schema creation

Most back ends will need to perform some sort of schema creation routine before the repositories are ready to use. The behavior of using the repositories without schema creation will vary dramatically, depending on the back end. The cassandra back end will not run at all. MongoDB is more forgiving, and the repositories will function without any schema creation, but performance will suffer due to the lack of indexes. (You will also fail to get any exceptions due to duplicate key values, as discussed in the section on method Repo.create.) For the in-memory back end, schema creation is a no-op.

You can create the requisite schema by calling RepoPool.createSchema(). This is an asynchronous method, so you will need to provide an implicit ExecutionContext, and you will want to ensure the asynchronous method completes before starting to use your repositories. It returns a Future[Unit] - that is, the completion of the future will only indicate success or failure.

An alternative way to generate schema is to set the configuration flag longevity.autocreateSchema to true. In this case, schema will be generated when the RepoPool is first accessed. Unlike calling RepoPool.createSchema(), schema autogeneration happens in a synchronous (i.e., blocking) manner. Schema autogeneration is a convenient feature for testing or development work, but will incur an overhead for every program run.

Schema generation is always a non-destructive process, and you will never lose any data when generating schema.

prev: repo pools
up: the longevity context
next: creating many aggregates at once