Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jetbrains/xodus-dnq
Data definition and queries Kotlin DSL over Xodus
https://github.com/jetbrains/xodus-dnq
database hub kotlin nosql xodus xodus-dnq youtrack
Last synced: 5 days ago
JSON representation
Data definition and queries Kotlin DSL over Xodus
- Host: GitHub
- URL: https://github.com/jetbrains/xodus-dnq
- Owner: JetBrains
- License: apache-2.0
- Created: 2016-11-04T12:22:43.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2025-01-12T07:38:16.000Z (11 days ago)
- Last Synced: 2025-01-18T10:07:55.874Z (5 days ago)
- Topics: database, hub, kotlin, nosql, xodus, xodus-dnq, youtrack
- Language: Kotlin
- Size: 3.22 MB
- Stars: 86
- Watchers: 14
- Forks: 25
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# 
[](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)
[](https://maven-badges.herokuapp.com/maven-central/org.jetbrains.xodus/dnq)
[](https://travis-ci.org/JetBrains/xodus-dnq)
[](https://www.apache.org/licenses/LICENSE-2.0.html)
[](https://stackoverflow.com/questions/tagged/xodus-dnq)
Xodus-DNQ is a Kotlin library that contains the data definition language and queries for
[Xodus](https://github.com/JetBrains/xodus), a transactional schema-less embedded database.
Xodus-DNQ provides the same support for Xodus that ORM frameworks provide for SQL databases.
With Xodus-DNQ, you can define your persistent meta-model using Kotlin classes.
JetBrains team tools [YouTrack](https://jetbrains.com/youtrack) and [Hub](https://jetbrains.com/hub) use Xodus-DNQ for
persistent layer definition.
More documentation https://jetbrains.github.io/xodus-dnq.
## Quick Start Guide
### Install to your project
[](https://maven-badges.herokuapp.com/maven-central/org.jetbrains.xodus/dnq)
List of released versions is available at https://github.com/JetBrains/xodus-dnq/releases.
#### Gradle
```groovy
repositories {
mavenCentral()
}
compile 'org.jetbrains.xodus:dnq:${version}'
```
#### Maven
```xml
org.jetbrains.xodus
dnq
$version
```
### Use Xodus-DNQ
[See code in repository](https://github.com/JetBrains/xodus-dnq/blob/master/dnq/src/test/kotlin/kotlinx/dnq/sample/SampleShortApp.kt).
```kotlin
// Define persistent class. It should extend XdEntity
class XdPost(entity: Entity) : XdEntity(entity) {
// and have component object of type XdEntityType
companion object : XdNaturalEntityType()
// Define persistent property of type org.joda.time.DateTime?
var publishedAt by xdDateTimeProp()
// Define required persistent property of type String
var text by xdRequiredStringProp()
}
class XdBlog(entity: Entity) : XdEntity(entity) {
companion object : XdNaturalEntityType()
// Define multi-value link to XdPost
val posts by xdLink0_N(XdPost)
}
fun main(args: Array) {
// Register persistent classes
XdModel.registerNodes(XdPost, XdBlog)
// Initialize Xodus persistent storage
val xodusStore = StaticStoreContainer.init(
dbFolder = File(System.getProperty("user.home"), ".xodus-dnq-blog-db"),
environmentName = "db"
)
// Initialize Xodus-DNQ metadata
initMetaData(XdModel.hierarchy, xodusStore)
// Do in transaction
val blog = xodusStore.transactional {
// Find an existing blog in database
XdBlog.all().firstOrNull()
// or create a new one if there are no blogs yet
?: XdBlog.new()
}
xodusStore.transactional {
// Create new post
val post = XdPost.new {
this.publishedAt = DateTime.now()
this.text = args.firstOrNull() ?: "Empty post"
}
// Add new post to blog
blog.posts.add(post)
}
// Do in read-only transaction
xodusStore.transactional(readonly = true) {
// Print all blog posts
for (post in blog.posts) {
println("${post.publishedAt}: ${post.text}")
}
}
}
```
## Find out more
- [Read documentation](https://jetbrains.github.io/xodus-dnq)
- [Report an issue](https://github.com/JetBrains/xodus-dnq/issues/new)
- [Ask question at Stack Overflow](https://stackoverflow.com/questions/tagged/xodus-dnq)
- [Learn more about Xodus](https://github.com/JetBrains/xodus)