Skip to content

Commit d00bcc9

Browse files
committedSep 6, 2023
Updating docs
1 parent 0c9645b commit d00bcc9

File tree

7 files changed

+58
-21
lines changed

7 files changed

+58
-21
lines changed
 

‎Extensions/AwsS3/README.md

+15-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,24 @@
1-
# AWS S3 Extension (beta)
1+
# AWS S3 Extension
22

3-
The AWS S3 extension provides writing of formatted files to AWS S3 buckets.
3+
The AWS S3 extension provides reading and writing of formatted files to AWS S3 buckets.
44

55
> **Note**: This is a Binary Storage Extension that is only used in combination with File Format extensions.
66
77
## Settings
88

9-
Sink settings require all parameters shown below.
9+
Source and Sink settings require the parameters shown below.
10+
11+
### Source
12+
13+
```json
14+
{
15+
"FileName": "",
16+
"S3Region": "us-west-1",
17+
"S3BucketName": "",
18+
"S3AccessKey": "",
19+
"S3SecretKey": ""
20+
}
21+
```
1022

1123
### Sink
1224

‎Extensions/AzureBlob/Cosmos.DataTransfer.AzureBlobStorage/AzureBlobSinkSettings.cs

-15
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,4 @@ public class AzureBlobSinkSettings : IDataExtensionSettings
1818

1919
public int? MaxBlockSizeinKB { get; set; }
2020
}
21-
22-
public class AzureBlobSourceSettings : IDataExtensionSettings
23-
{
24-
[Required]
25-
[SensitiveValue]
26-
public string ConnectionString { get; set; } = null!;
27-
28-
[Required]
29-
public string ContainerName { get; set; } = null!;
30-
31-
[Required]
32-
public string BlobName { get; set; } = null!;
33-
34-
public int? ReadBufferSizeInKB { get; set; }
35-
}
3621
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
using Cosmos.DataTransfer.Interfaces;
2+
using System.ComponentModel.DataAnnotations;
3+
using Cosmos.DataTransfer.Interfaces.Manifest;
4+
5+
namespace Cosmos.DataTransfer.AzureBlobStorage;
6+
7+
public class AzureBlobSourceSettings : IDataExtensionSettings
8+
{
9+
[Required]
10+
[SensitiveValue]
11+
public string ConnectionString { get; set; } = null!;
12+
13+
[Required]
14+
public string ContainerName { get; set; } = null!;
15+
16+
[Required]
17+
public string BlobName { get; set; } = null!;
18+
19+
public int? ReadBufferSizeInKB { get; set; }
20+
}

‎Extensions/AzureBlob/README.md

+17-3
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,29 @@
1-
# Azure Blob Storage Extension (beta)
1+
# Azure Blob Storage Extension
22

3-
The Azure Blob Storage extension provides writing of formatted files to Azure Blob Storage containers.
3+
The Azure Blob Storage extension provides reading and writing of formatted files to Azure Blob Storage containers.
44

55
> **Note**: This is a Binary Storage Extension that is only used in combination with File Format extensions.
66
77
## Settings
88

9-
Sink settings require all parameters shown below. An optional `MaxBlockSizeInKB` parameter can also be specified to control the transfer.
9+
Source and Sink settings require the parameters shown below.
10+
11+
### Source
12+
13+
An optional `ReadBufferSizeInKB` parameter can be used to control stream buffering.
14+
15+
```json
16+
{
17+
"ConnectionString": "DefaultEndpointsProtocol=https;AccountName=...",
18+
"ContainerName": "",
19+
"BlobName": "",
20+
}
21+
```
1022

1123
### Sink
1224

25+
An optional `MaxBlockSizeInKB` parameter can also be specified to control the transfer.
26+
1327
```json
1428
{
1529
"ConnectionString": "DefaultEndpointsProtocol=https;AccountName=...",

‎Extensions/Csv/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ Supported storage sinks:
1313

1414
Supported storage sources:
1515
- File - **Csv**
16+
- Azure Blob Storage - **Csv-AzureBlob**
17+
- AWS S3 - **Csv-AwsS3**
1618

1719
## Settings
1820

‎Extensions/Json/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ Supported storage sinks:
1313

1414
Supported storage sources:
1515
- File - **Json**
16+
- Azure Blob Storage - **Json-AzureBlob**
17+
- AWS S3 - **Json-AwsS3**
1618

1719
## Settings
1820

‎Extensions/Parquet/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ Supported storage sinks:
1313

1414
Supported storage sources:
1515
- File - **Parquet**
16+
- Azure Blob Storage - **Parquet-AzureBlob**
17+
- AWS S3 - **Parquet-AwsS3**
1618

1719
## Settings
1820

0 commit comments

Comments
 (0)
Please sign in to comment.