{"id":21125348,"url":"https://github.com/teamapps-org/universal-db","last_synced_at":"2025-07-08T22:31:10.371Z","repository":{"id":262238046,"uuid":"209980386","full_name":"teamapps-org/universal-db","owner":"teamapps-org","description":"UniversalDB - ultra fast TeamApps database","archived":false,"fork":false,"pushed_at":"2025-02-17T13:57:03.000Z","size":1396,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-04T12:22:54.061Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/teamapps-org.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-09-21T12:21:23.000Z","updated_at":"2025-02-17T13:57:07.000Z","dependencies_parsed_at":"2024-11-11T11:39:16.341Z","dependency_job_id":null,"html_url":"https://github.com/teamapps-org/universal-db","commit_stats":null,"previous_names":["teamapps-org/universal-db"],"tags_count":87,"template":false,"template_full_name":null,"purl":"pkg:github/teamapps-org/universal-db","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teamapps-org%2Funiversal-db","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teamapps-org%2Funiversal-db/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teamapps-org%2Funiversal-db/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teamapps-org%2Funiversal-db/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/teamapps-org","download_url":"https://codeload.github.com/teamapps-org/universal-db/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teamapps-org%2Funiversal-db/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263854603,"owners_count":23520334,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-20T04:24:16.388Z","updated_at":"2025-07-08T22:31:09.844Z","avatar_url":"https://github.com/teamapps-org.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# UniversalDB\n\nAn ultra fast embedded persisting in-memory database:\n\n* Easy and intuitive API through generated POJOs\n* Integrated full text search - including complex joins\n* Integrated file storage - either local or S3 compatible storage with AWS or min.io\n* File parsing and full text indexing\n\n### Setting up the dependencies\n\nCurrent UniversalDB version: [![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.teamapps/universal-db/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.teamapps/universal-db)\n```xml\n\u003cdependency\u003e\n  \u003cgroupId\u003eorg.teamapps\u003c/groupId\u003e\n  \u003cartifactId\u003euniversal-db\u003c/artifactId\u003e\n  \u003cversion\u003e0.5.2\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n## Build configuration\n\nAdd this to your pom.xml:\n\n```xml\n    \u003cbuild\u003e\n        \u003cplugins\u003e\n            \u003cplugin\u003e\n                \u003cgroupId\u003eorg.teamapps\u003c/groupId\u003e\n                \u003cartifactId\u003euniversal-db-maven-plugin\u003c/artifactId\u003e\n                \u003cversion\u003e1.2\u003c/version\u003e\n                \u003cexecutions\u003e\n                    \u003cexecution\u003e\n                        \u003cphase\u003egenerate-sources\u003c/phase\u003e\n                        \u003cgoals\u003e\n                            \u003cgoal\u003egenerate-model\u003c/goal\u003e\n                        \u003c/goals\u003e\n                        \u003cconfiguration\u003e\n                            \u003cmodelSourceDirectory\u003e${project.basedir}/src/main/model\u003c/modelSourceDirectory\u003e\n                            \u003cmodelClasses\u003e\n                                \u003cmodelClass\u003eMyAppModel\u003c/modelClass\u003e\n                            \u003c/modelClasses\u003e\n                        \u003c/configuration\u003e\n                    \u003c/execution\u003e\n                \u003c/executions\u003e\n            \u003c/plugin\u003e\n        \u003c/plugins\u003e\n    \u003c/build\u003e\n```\n\n## Create UniversalDB schema \n\nAdd a source folder e.g. `/src/main/model` and create a model class e.g. `MyAppModel` with the model you want to use:\n\n```java\nimport org.teamapps.universaldb.schema.*;\n\npublic class MyAppModel implements ModelProvider {\n\n\tpublic Schema getSchema() {\n\t\tSchema schema = Schema.create(\"org.teamapps.myapp.model\");\n\t\tschema.setSchemaName(\"MyAppSchema\");\n\t\tDatabase database = schema.addDatabase(\"myAppDb\");\n\t\tTable user = database.addTable(\"user\");\n\t\tTable project = database.addTable(\"project\");\n\t\tuser\n\t\t\t\t.addText(\"name\")\n\t\t\t\t.addText(\"text2\")\n\t\t\t\t.addTimestamp(\"timestamp\")\n\t\t\t\t.addEnum(\"enumValue\", \"value1\", \"value2\", \"value3\")\n\t\t\t\t.addInteger(\"number\")\n\t\t\t\t.addLong(\"bigNumber\")\n\t\t\t\t.addReference(\"projects\", project, true, \"manager\");\n\n\t\tproject\n\t\t\t\t.addText(\"title\")\n\t\t\t\t.addReference(\"manager\", user, false, \"projects\");\n\n\t\treturn schema;\n\t}\n}\n```\nAfter compiling you will have a User and a Project class to work with.\n\n```java\npackage org.teamapps.myapp;\n\nimport org.teamapps.myapp.model.myappdb.Project;\nimport org.teamapps.myapp.model.myappdb.User;\nimport org.teamapps.myapp.model.myappdb.UserQuery;\nimport org.teamapps.universaldb.UniversalDB;\nimport org.teamapps.myapp.model.MyAppSchema;\nimport org.teamapps.universaldb.index.text.TextFilter;\n\nimport java.io.File;\nimport java.util.List;\n\npublic class MyApp {\n\n    public static void main(String[] args) throws Exception {\n        startDb();\n        createInitialData();\n        query1();\n        filterQuery1();\n    }\n    private static void startDb() throws Exception {\n        File storagePath = new File(\"./server-data/db-storage\");\n        if (!storagePath.exists()) {\n            if (!storagePath.mkdirs()) System.out.println(\"Error creating Database directory!\");\n        }\n        UniversalDB.createStandalone(storagePath, new MyAppSchema());\n    }\n    private static void createInitialData() {\n        if (User.getCount() \u003e 0) {\n            System.out.println(\"DB already contains data, don't create new entries\");\n            return;\n        }\n        User user1 = User.create().setName(\"FirstUser\").save();\n        Project project1 = Project.create().setTitle(\"ProjectOne\");\n        user1.addProjects(project1).save();\n    }\n    private static void query1() {\n        User.getAll().forEach(user -\u003e {\n            user.getProjects().forEach(project -\u003e {\n                System.out.println(user.getName()+ \" has project \" + project.getTitle());\n            });\n        });\n    }\n    private static void filterQuery1() {\n        UserQuery firstQuery = User.filter().name(TextFilter.termContainsFilter(\"First\"));\n        List\u003cUser\u003e firstUserList = firstQuery.execute();\n        long firstUserProjectCount = Project.filter().filterManager(firstQuery).execute().stream().count();\n        System.out.println(\"There are \" + firstUserProjectCount + \" projects where the Manager's name contains 'First'\");\n    }\n}\n\n```\n\n## License\n\nThe UniversalDB maven plugin is released under version 2.0 of the [Apache License](https://www.apache.org/licenses/LICENSE-2.0).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteamapps-org%2Funiversal-db","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fteamapps-org%2Funiversal-db","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteamapps-org%2Funiversal-db/lists"}