nebtex/old-omniql

omniql is an opinionated query shema, also provide nice tooling like kubernetes for manage it. this tooling is being writted on omniql itself

---

omniql is opinionated way to create schemas and define commons operation over them, is intended to be useful for large project where teams of diferent background converge, omniql schemas can be used in any devices, for internal or external application, collaborate and api creations, api versioning and export them to the world.

Keys aspect:

• it uses cqs (Command and Query Responsibility Segregation) if you don't know what is this please read https://martinfowler.com/bliki/CQRS.html
• all the communication is planned to be over nats or kafka or similar software (centrifuge for the frontend)
• it should try to use the open api 3 spec https://github.com/OAI/OpenAPI-Specification/blob/3.0.0-rc0/versions/3.0.md, like a guide when is possible
• also we should use the google api design spec https://cloud.google.com/apis/design/
• large inspired by kubernetes and swagger

what omniql should offer:

• creation of schemas in a nice interface (api and ui)
• auto-generation of code for different programming languages and provide the tooling to do this
• auto-generation of entry docker containers that can handle well known patterns like crud, subscriptions, permissions

plan:

• do an initial version, working
• build omniql on omniql

oriented to:

• large organization that has many team of different backgrounds
• microservice infrastructures
• iot
• rapid development thanks to the auto component creation (this mean that omniql can create entery or partial application, with all the bussiness logic in it), manage github, repos and creation of docker containers

Why is this project needed?

is still difficult to create good schema, maintain track of them, share between the team with the current tech, if we have a good tool for create schemas, this will decrease the work needed to get things done, in organization that worry about infrastructure evolution. more easy work, more people happy

similar software:

• apache thirft
• swagger
• grpc

spec

this is the spec for the version V1Alpha, it will change almost every time possible, nothing that is written here is the last word

Resources

V1Alpha:

things that should be ready for the first alpha release

• V1Alpha.Application
• V1Alpha.Enumeration
• V1Alpha.EnumerationItem
• V1Alpha.Structure
• V1Alpha.Table
• V1Alpha.Resource
• V1Alpha.Command
• V1Alpha.Query
• V1Alpha.Component

V1Next

things that would be nice to have

• V1Alpha.Branch
• V1Alpha.Environment
• V1Alpha.Version
• V1Alpha.Pipelines [planning]
• V1Alpha.PipelineBranch [planning]
• V1Alpha.Subscription [planning]

Omniql APp

Omniql application on top of omniql definition that allow to manage resources by federation, orgs , team and users

• V1Alpha.Federation
• V1Alpha.Organization
• V1Alpha.Team
• V1Alpha.Users

Code generation

old-omniql's Issues

add code generation docs

end subscripction desing spec

create gitbook docs and put it on omniql.io