https://github.com/basestar/basestar
Basestar
https://github.com/basestar/basestar
api database schema
Last synced: 9 months ago
JSON representation
Basestar
- Host: GitHub
- URL: https://github.com/basestar/basestar
- Owner: basestar
- License: apache-2.0
- Created: 2020-04-05T15:58:55.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-27T14:41:13.000Z (over 3 years ago)
- Last Synced: 2025-07-04T14:52:46.608Z (12 months ago)
- Topics: api, database, schema
- Language: Java
- Size: 7.56 MB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
 [](https://maven-badges.herokuapp.com/maven-central/io.basestar/basestar)
# The modern, declarative data toolkit
Writing CRUD layers is a pain, maintaining generated CRUD layers is a pain, you've defined CRUD APIs a million times, and you want to get on with the interesting parts of your project - you should be able to describe your data, the relationships between your data, and rules for accessing your data succinctly, in one place, and all of the infrastructure and machinery implied by that declaration should just exist.
You shouldn't have to choose between tools that work for your web-app and tools that work for massive scale - online or offline - data processing and analysis. You shouldn't be constrained to one implementation, or trapped by one cloud provider.
Basestar solves a relatively simple problem, but it solves it comprehensively and gives you simplicity and power without taking away flexibility or control.
## Get started
Pick the parts you need, for example:
```xml
io.basestar
basestar-database-server
${basestar.version}
io.basestar
basestar-storage-dynamodb
${basestar.version}
```
## Schema first design
See: [Basestar schema (basestar-schema)](basestar-schema)
## Integrated expression language
See: [Basestar expressions (basestar-expression)](basestar-expression)
## Row-level security
Write me
## Multi-value indexes
Write me
## Storage engines
- [DynamoDB](basestar-storage-dynamodb)
- [Cognito users/groups](basestar-storage-cognito)
- [Elasticsearch](basestar-storage-elasticsearch)
- [SQL (dialects as per JOOQ)](basestar-storage-sql)
- [Hazelcast](basestar-storage-hazelcast)
- [S3](basestar-storage-s3)
- [Spark](basestar-storage-spark)
## Examples
```yaml
Principal:
type: object
User:
type: object
extend: Principal
links:
groups:
schema: Group
expression: member.id == this.id for any member in members
Group:
type: object
extend: Principal
properties:
members:
array: User
indexes:
over:
member: members
partition:
- member.id
Project:
type: object
properties:
owner:
type: Principal
permissions:
read:
expression: this.principal.id in {caller.id} + {group.id for group in caller.groups}
expand:
- caller.groups
Thing:
type: object
properties:
project:
type: Project
permissions:
read:
inherit:
- project.read
```