https://github.com/soontao/cds-materialized-view
CDS Materialized View
https://github.com/soontao/cds-materialized-view
cap cds materialized-view
Last synced: 2 months ago
JSON representation
CDS Materialized View
- Host: GitHub
- URL: https://github.com/soontao/cds-materialized-view
- Owner: Soontao
- License: other
- Created: 2022-11-23T11:52:07.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-08T00:44:11.000Z (3 months ago)
- Last Synced: 2025-03-08T01:28:47.165Z (3 months ago)
- Topics: cap, cds, materialized-view
- Language: TypeScript
- Homepage:
- Size: 1.16 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CDS Materialized View
> Materialized View for CAP NodeJS Runtime
[](https://www.npmjs.com/package/cds-materialized-view)
[](https://github.com/Soontao/cds-materialized-view/actions/workflows/nodejs.yml)
[](https://codecov.io/gh/Soontao/cds-materialized-view)
## Get Started
### Prerequisites
`cds-materialized-view` depends on the [`cds-mtxs`](https://cap.cloud.sap/docs/guides/multitenancy/mtxs) features/services, so MUST setup `cds-mtxs` firstly.
### Setup
enable plugin
```json
{
"cds": {
"plugins": ["cds-materialized-view"],
"materialized": {
"view": {
"refresh": {
"interval": 1800
}
}
}
}
}
```
then annotate some view with annotations
```groovy
namespace test.resources.csv.app.db;
entity Person {
key ID : Integer;
Name : String(255);
}
@cds.materialized.view // create materialized view
@cds.materialized.interval : 3600 // refresh interval: per hour
view UniqPersonNames as select distinct Name from Person;
```
now, it works!
## Parameters
- `cds.materialized.view.refresh.jobs` - default `true` - enable job to refresh views, typically maybe need to setup only one instance to run the jobs
- `cds.materialized.view.refresh.interval` - default `3600 seconds` - default global refresh interval for materialized view, for each view developer could use `@cds.materialized.interval` annotation to overwrite this
- `cds.materialized.view.refresh.concurrency` - default `10` - concurrency of materialized view refresh
- `cds.materialized.check.view.interval` - default `1 second` - interval between collect views need to be refreshed, then refresh them
- `cds.materialized.view.refresh.header` - default `false` - add `x-cds-materialized-view-refresh-at` header to response
## Features
- [x] support materialized view
- [x] create table for materialized view
- [x] rewrite query
- [ ] rewrite string query
- [ ] rewrite array query
- [x] filter
- [x] aggregation
- [ ] view join table
- [ ] virtual elements
- [ ] projection join
- [ ] shortcut for `$count` query
- [ ] hottest query
- [ ] count all
- [x] support `x-cds-materialized-view-refresh-at`
- [ ] support reuse existed materialized view
- [ ] support to `redirect` to existed materialized view
- [ ] support new service(interface) to support refresh materialized view by API/Rest API
## [LICENSE](./LICENSE)