Skip to content

Commit 96113e0

Browse files
Enhance Attachments plugin documentation for clarity and integration … (#2263)
…options --------- Co-authored-by: René Jeglinsky <[email protected]>
1 parent f3d1e91 commit 96113e0

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

cds/types.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ These types are used to define the structure of entities and services, and are m
4141
| `Timestamp` | _µs_ precision, with up to 7 fractional digits | _TIMESTAMP_ |
4242
| `String` (`length`) | Default *length*: 255; on HANA: 5000 <sup>(4)(5)</sup> | _NVARCHAR_ |
4343
| `Binary` (`length`) | Default *length*: 255; on HANA: 5000 <sup>(4)(6)</sup> | _VARBINARY_ |
44-
| `LargeBinary` | Unlimited data, usually streamed at runtime | _BLOB_ |
44+
| `LargeBinary` | Unlimited data, usually streamed at runtime<br/>[Prefer using Attachments plugin for large files](../plugins/index.md#attachments) | _BLOB_ |
4545
| `LargeString` | Unlimited data, usually streamed at runtime | _NCLOB_ |
4646
| `Map` | Mapped to *NCLOB* for HANA. | *JSON* type |
4747
| `Vector` (`dimension `) | Requires SAP HANA Cloud QRC 1/2024, or later | _REAL_VECTOR_ |

plugins/index.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,12 @@ Available for:
168168
## Attachments
169169

170170

171-
The Attachments plugin provides out-of-the-box support for attachment handling. On Node.js, attachments are stored on AWS S/3 through [SAP BTP's Object Store service](https://discovery-center.cloud.sap/serviceCatalog/object-store). For Java: When using the package [`cds-feature-attachments-oss`](https://central.sonatype.com/artifact/com.sap.cds/cds-feature-attachments-oss), depending on your cloud environment, attachments are stored on AWS S/3, Microsoft Azure, or the Google object store through [SAP BTP's Object Store service](https://discovery-center.cloud.sap/serviceCatalog/object-store). When using the package [`cds-feature-attachments`](https://central.sonatype.com/artifact/com.sap.cds/cds-feature-attachments), attachments are stored on the SAP HANA database.
171+
The Attachments plugin enables efficient management of file attachments within your applications. By default, attachments are stored in the SAP HANA database.
172+
173+
For Java, use the package [`cds-feature-attachments`](https://central.sonatype.com/artifact/com.sap.cds/cds-feature-attachments). For Node.js, this is supported by the standard plugin.
174+
175+
To integrate with cloud storage solutions such as `AWS S3`, `Azure Blob Storage`, or `Google Cloud Storage` through [SAP BTP's Object Store service](https://discovery-center.cloud.sap/serviceCatalog/object-store), use the [`cds-feature-attachments-oss`](https://central.sonatype.com/artifact/com.sap.cds/cds-feature-attachments-oss) package for Java or the [`@cap-js/attachments`](https://www.npmjs.com/package/@cap-js/attachments) package for Node.js.
176+
172177
To use the Attachments plugin, simply add a composition of the predefined aspect `Attachments` like so:
173178

174179
```cds
@@ -184,7 +189,7 @@ That's all we need to automatically add an interactive list of attachments to yo
184189

185190
Features:
186191

187-
- Pre-defined type `Attachment` to use in entity definitions
192+
- Pre-defined type `Attachments` to use in entity definitions
188193
- Automatic handling of all upload and download operations
189194
- Automatic malware scanning for uploaded files
190195
- (Automatic) Fiori Annotations for Upload Controls

0 commit comments

Comments
 (0)