https://github.com/igapyon/oiyokan

Oiyokan is an OData v4 server (provider) SDK for RDB. You can use Oiyokan to turn RDBMS into OData v4 services using JDBC driver. Based on Apache Olingo / h2 database.
https://github.com/igapyon/oiyokan

h2-database java jdbc mysql odata odatav4 oiyokan olingo oracle-xe postgresql rest-api sdk sqlserver-2008 v4

Last synced: 18 days ago
JSON representation

Oiyokan is an OData v4 server (provider) SDK for RDB. You can use Oiyokan to turn RDBMS into OData v4 services using JDBC driver. Based on Apache Olingo / h2 database.

• Host: GitHub
• URL: https://github.com/igapyon/oiyokan
• Owner: igapyon
• License: apache-2.0
• Created: 2021-03-18T21:07:20.000Z (over 3 years ago)
• Default Branch: devel
• Last Pushed: 2021-06-20T13:46:08.000Z (over 3 years ago)
• Last Synced: 2024-10-12T07:09:02.160Z (about 1 month ago)
• Topics: h2-database, java, jdbc, mysql, odata, odatav4, oiyokan, olingo, oracle-xe, postgresql, rest-api, sdk, sqlserver-2008, v4
• Language: Java
• Homepage:
• Size: 15.9 MB
• Stars: 12
• Watchers: 4
• Forks: 3
• Open Issues: 33
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Oiyokan

Oiyokan is an OData v4 server (provider) SDK for RDB.

You can use Oiyokan to turn RDBMS into OData v4 services.

- Based on Apache Olingo. Build with Servlet, Java, h2.

- Oiyokan uses JDBC to provide OData v4 access to the RDB.

- Source code at github, license : Apache License.

## Getting Started with the Oiyokan

Getting Started with the Oiyokan can be viewed at the following URL  (written in Japanese).

- http://www.igapyon.jp/igapyon/diary/2021/ig210511.html

## Supported target RDBMS

- h2 database (1.4)

- PostgreSQL (13)

- MySQL (8)

- SQL Server (2008)

- Oracle XE (18c)

## Supported OData Method

- GET

- POST

- PATCH

- DELETE

see `spec-httpmethod.md` for more details.

## Supported OData system query options

- $select

- $count

- $filter

- $orderby

- $top

- $skip

see `spec-notsupported.md` for more details.

## Oiyokan in Maven repository

- [Maven Repository - Oiyokan](https://mvnrepository.com/artifact/jp.igapyon.oiyokan)

## Oiyokan 関連リポジトリ 

- [Oiyokan Library - github](https://github.com/igapyon/oiyokan)

- [Oiyokan Initializr - github](https://github.com/igapyon/oiyokan-initializr)

- [Oiyokan UnitTest - github](https://github.com/igapyon/oiyokan-unittest)

- [Oiyokan Demosite - github](https://github.com/igapyon/oiyokan-demosite)

- [Oiyokan Demosite-Test - github](https://github.com/igapyon/oiyokan-demosite-test)

## Sample implementation using Oiyokan

- Oiyokan provides OData server sample of Sakila DVD rental.

- see details at: https://github.com/igapyon/oiyokan-demosite

# Try the Oiyokan OData v4 sample server

## Heroku

You can find the running OData v4 sample server at Heroku.

- https://oiyokan.herokuapp.com/

# How to setup OData v4 setting

## oiyokan-settings.json の設定を更新

- 最も重要なのは Oiyokan の設定ファイルを変更して、接続したいデータベース情報を記述することです。

- より詳しい内容はソースコードから読み込むことにより得られます。

```sh

src/main/resources/oiyokan/oiyokan-settings.json

```

# Oiyokan 関連情報

## OData v4 server のサンプル(simple-odata4) を祖先

oiyokan プロジェクトは、OData v4 server のシンプルなサンプル(https://github.com/igapyon/simple-odata4) を祖先に作成されたものです。

## Oiyokanに関連するその他情報

### Olingo による OData v4 server チュートリアル

OData v4 / Apache Olingo そのものの学習には Apache Olingo サイトの参照が有益です。

- https://olingo.apache.org/doc/odata4/index.html

### 参考: h2情報

- http://www.h2database.com/html/functions.html