Skip to content

Commit

Permalink
docs: improve all README.mds (#738)
Browse files Browse the repository at this point in the history 
- the cap-js dbs are now default -> remove `new`
- fix typos
- fix links
- improve wording and formatting
  • Loading branch information
@patricebender
patricebender authored Jul 15, 2024
1 parent b65de2b commit 8b19be3
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 22 deletions.
8 changes: 3 additions & 5 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,16 @@

# Welcome to the @cap-js/cds-dbs Monorepo


This is a monorepo for our SQL Database Services.

It contains subfolders for the [base database service implementation](./db-service/) as well as the implementation of this interface for [sqlite](./sqlite/) and [postgres](./postgres/).
It contains subfolders for the [base database service implementation](./db-service/) as well as the implementation of this interface for [SQLite](./sqlite/), [PostgreSQL](./postgres/) and [SAP HANA](./hana/).
Each of the subfolders is published as individual npm module.

Documentation can be found at [cap.cloud.sap](https://cap.cloud.sap/docs/guides/databases).

## Prerequisites

See [Getting Started](https://cap.cloud.sap/docs/get-started) on how to jumpstart your development and grow as you go with [SAP Cloud Application Programming Model](https://cap.cloud.sap).
See [Getting Started](https://cap.cloud.sap/docs/get-started/in-a-nutshell) on how to jumpstart your development and grow as you go with [SAP Cloud Application Programming Model](https://cap.cloud.sap).

## Setup

Expand All @@ -26,7 +25,6 @@ npm add @cap-js/sqlite -D

Learn more about setup and usage in the [respective database guides](https://cap.cloud.sap/docs/guides/databases).


## Support

This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/cap-js/cds-dbs/issues).
Expand All @@ -41,4 +39,4 @@ We as members, contributors, and leaders pledge to make participation in our com

## Licensing

Copyright 2023 SAP SE or an SAP affiliate company and cds-dbs contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/cap-js/cds-dbs).
Copyright 2024 SAP SE or an SAP affiliate company and cds-dbs contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/cap-js/cds-dbs).
6 changes: 3 additions & 3 deletions db-service/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# CDS base database service

Welcome to the new base database service for [SAP Cloud Application Programming Model](https://cap.cloud.sap) Node.js, based on new, streamlined database architecture.
Welcome to the base database service for [SAP Cloud Application Programming Model](https://cap.cloud.sap) Node.js. This service forms the core of all supported databases and is the base of our streamlined database architecture.

Find documentation at https://cap.cloud.sap/docs/guides/databases
Find documentation at <https://cap.cloud.sap/docs/guides/databases>

## Support

Expand All @@ -23,4 +23,4 @@ We as members, contributors, and leaders pledge to make participation in our com

## Licensing

Copyright 2023 SAP SE or an SAP affiliate company and cds-dbs contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/cap-js/cds-dbs).
Copyright 2024 SAP SE or an SAP affiliate company and cds-dbs contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/cap-js/cds-dbs).
7 changes: 3 additions & 4 deletions hana/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
# CDS database service for SAP HANA

Welcome to the new SAP HANA database service for [SAP Cloud Application Programming Model](https://cap.cloud.sap) Node.js, based on new, streamlined database architecture.
Welcome to the SAP HANA database service for [SAP Cloud Application Programming Model](https://cap.cloud.sap) Node.js, based on streamlined database architecture.

## Setup

In general, all you need to do is to install one of the database packages, as follows:
All you need to do is to install the database package, as follows:

```sh
npm add @cap-js/hana
```

Learn more about setup and usage in the [respective database guide](https://cap.cloud.sap/docs/guides/databases-hana).


## Support

This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/cap-js/cds-dbs/issues).
Expand All @@ -27,4 +26,4 @@ We as members, contributors, and leaders pledge to make participation in our com

## Licensing

Copyright 2023 SAP SE or an SAP affiliate company and cds-dbs contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/cap-js/cds-dbs).
Copyright 2024 SAP SE or an SAP affiliate company and cds-dbs contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/cap-js/cds-dbs).
10 changes: 5 additions & 5 deletions postgres/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# CDS database service for Postgres

Welcome to the new Postgres database service for [SAP Cloud Application Programming Model](https://cap.cloud.sap) Node.js, based on new, streamlined database architecture and [*pg* driver](https://www.npmjs.com/package/pg) .
Welcome to the PostgreSQL database service for [SAP Cloud Application Programming Model](https://cap.cloud.sap) Node.js, based on streamlined database architecture and [*pg* driver](https://www.npmjs.com/package/pg) .

## Setup

In general, all you need to do is to install one of the database packages, as follows:
In general, all you need to do is to install the database package, as follows:

```sh
npm add @cap-js/postgres
Expand Down Expand Up @@ -38,7 +38,7 @@ Copyright 2023 SAP SE or an SAP affiliate company and cds-dbs contributors. Plea
`@cap-js/postgres` works as a drop-in replacement for `cds-pg`.
However, some preliminary checks and cleanups help:

- for using the BTP Postgres Hyperscaler as database,
- for using the BTP Postgres Hyperscaler as database,
- know that the credentials are picked up automatically by from the enviornment (`VCAP_SERVICES.postgres`)
- the service binding label is `postgresql-db`
- `cds-dbm` is replaced by a hand-crafted "db-deployer" app &rarr; see below
Expand Down Expand Up @@ -134,11 +134,11 @@ now, re-use the CDS definitions: `SELECT.from(Beers).columns('brewery_ID').group

So please adjust your `CQL` statements accordingly.

### timezones (potential _**BREAKING CHANGE**_)
### timezones (potential **BREAKING CHANGE**)

any date- + time-type will get stored in [`UTC`](https://en.wikipedia.org/wiki/Coordinated_Universal_Time) **without any timezone identifier in the actual data field**.
CAP's inbound- and outbound adapters take care of converting incoming and outgoing data from/to the desired time zones.
So when a `dateime` comes in being in [an ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compatible format
So when a `datetime` comes in being in [an ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compatible format
`2009-01-01T15:00:00+01:00` (15:00:00 on January 1 2009 in Vienna (CEST))
will get stored as
`2009-01-01T13:00:00` (13:00:00 on January 1 2009 in UTC).
Expand Down
8 changes: 3 additions & 5 deletions sqlite/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
# CDS database service for SQLite

Welcome to the new SQLite database service for [SAP Cloud Application Programming Model](https://cap.cloud.sap) Node.js, based on new, streamlined database architecture and [*better-sqlite* driver](https://www.npmjs.com/package/better-sqlite3) .
Welcome to the SQLite database service for [SAP Cloud Application Programming Model](https://cap.cloud.sap) Node.js, based on streamlined database architecture and [*better-sqlite* driver](https://www.npmjs.com/package/better-sqlite3).

## Setup

In general, all you need to do is to install one of the database packages, as follows:

Using SQLite for development:
If you want to use SQLite for development, all you need to do is to install the database package, as follows

```sh
npm add @cap-js/sqlite -D
Expand All @@ -33,4 +31,4 @@ We as members, contributors, and leaders pledge to make participation in our com

## Licensing

Copyright 2023 SAP SE or an SAP affiliate company and cds-dbs contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/cap-js/cds-dbs).
Copyright 2024 SAP SE or an SAP affiliate company and cds-dbs contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/cap-js/cds-dbs).

0 comments on commit 8b19be3

Please sign in to comment.