@tetrascience-npm/ts-connectors-sdk 4.0.0-beta.186.1 → 4.0.0-beta.187.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +31 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -104,6 +104,37 @@ const s3 = client.createAwsClient(S3Client);
|
|
|
104
104
|
const s3WithOverrides = client.createAwsClient(S3Client, { region: 'us-west-2' });
|
|
105
105
|
```
|
|
106
106
|
|
|
107
|
+
All clients created this way use a **generic request handler with a 120-second
|
|
108
|
+
timeout**, which is suitable for most AWS services.
|
|
109
|
+
|
|
110
|
+
**For S3 specifically**, the SDK already manages an internal `S3Client` tuned
|
|
111
|
+
with socket idle timeouts instead of a fixed request timeout — a better fit for
|
|
112
|
+
large or slow file transfers. If you need S3 access with that tuning, prefer
|
|
113
|
+
either of these over `createAwsClient(S3Client)`:
|
|
114
|
+
|
|
115
|
+
- **`uploadFile()`** — the primary way to upload files to the TDP datalake.
|
|
116
|
+
Handles credentials, metadata, checksums, and multipart uploads automatically.
|
|
117
|
+
- **`assertAwsInitialized().s3Client`** — returns the SDK-managed `S3Client`
|
|
118
|
+
directly, for cases where you need to make S3 calls beyond what `uploadFile()`
|
|
119
|
+
covers:
|
|
120
|
+
|
|
121
|
+
```ts
|
|
122
|
+
const { s3Client } = await client.assertAwsInitialized();
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
If you have a specific reason to create your own `S3Client` via `createAwsClient`
|
|
126
|
+
and still want the S3-tuned handler, you can pass it as an override:
|
|
127
|
+
|
|
128
|
+
```ts
|
|
129
|
+
const s3 = client.createAwsClient(S3Client, {
|
|
130
|
+
requestHandler: client.createProxyAWSNodeHttpHandlers().s3Handler,
|
|
131
|
+
});
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
Note that this creates new handler instances rather than sharing the SDK's
|
|
135
|
+
internal ones, so the simpler `assertAwsInitialized().s3Client` is preferred
|
|
136
|
+
when possible.
|
|
137
|
+
|
|
107
138
|
#### tdpDeploymentCertificates
|
|
108
139
|
|
|
109
140
|
A read-only getter that returns the TDP deployment certificates loaded during
|