Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document support for in-memory HyperSQL databases #224

Closed
zikolach opened this issue Nov 25, 2019 · 2 comments · Fixed by #363
Closed

Document support for in-memory HyperSQL databases #224

zikolach opened this issue Nov 25, 2019 · 2 comments · Fixed by #363
Assignees
Labels
backend.jdbc Interaction with ixmp_source via JDBCBackend & JPype docs Documentation, tutorials, etc.
Milestone

Comments

@zikolach
Copy link
Contributor

It might be useful for testing and some other cases when having a persisted DB is not needed (e.g. following tutorials). It was originally added to #219 but due to lack of time for creating documentation/writing tests/etc was not merged.

@zikolach zikolach added the enh New features & functionality label Nov 25, 2019
@khaeru
Copy link
Member

khaeru commented Dec 11, 2019

In #232 @zikolach added this file:

config.name = unit_test_db@local
jdbc.driver = org.hsqldb.jdbcDriver
jdbc.url = jdbc:hsqldb:mem://ixmptest
jdbc.user = ixmp
jdbc.pwd = ixmp

…used in:

def test_connect_message(caplog, test_data_path):
sample_props = test_data_path / 'testdb' / 'test.properties.sample'
ixmp.Platform(dbprops=sample_props)
assert caplog.records[-1].message == \
'launching ixmp.Platform connected to jdbc:hsqldb:mem://ixmptest'

This is a proof-of-concept & test that in-memory databases can be used. However, it is still not advertised, documented, or configurable (without use of a dbprops file).

@khaeru
Copy link
Member

khaeru commented Mar 10, 2020

Note that as part of #270 we now make extensive (almost exclusive) use of this in the test suite, so it's very well-supported. The documentation/public API/command-line configuration still needs work.

@khaeru khaeru added docs Documentation, tutorials, etc. and removed enh New features & functionality labels Mar 10, 2020
@khaeru khaeru changed the title Add hsqldb in-memory DB support Document suport for in-memory HyperSQL databases Mar 10, 2020
@khaeru khaeru added the backend.jdbc Interaction with ixmp_source via JDBCBackend & JPype label Apr 27, 2020
@khaeru khaeru added this to the 3.1 milestone Aug 20, 2020
@khaeru khaeru self-assigned this Aug 25, 2020
@khaeru khaeru changed the title Document suport for in-memory HyperSQL databases Document support for in-memory HyperSQL databases Aug 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend.jdbc Interaction with ixmp_source via JDBCBackend & JPype docs Documentation, tutorials, etc.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants