Skip to content

Commit 9b2274f

Browse files
alumnialumni
committed
feat(sap): use the native driver for connection pooling
1 parent b1e93f7 commit 9b2274f

File tree

16 files changed

+257
-206
lines changed

16 files changed

+257
-206
lines changed

‎README-zh_CN.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -203,9 +203,7 @@ await timber.remove()
203203
- **SAP Hana**
204204

205205
```
206-
npm config set @sap:registry https://npm.sap.com
207206
npm i @sap/hana-client
208-
npm i hdb-pool
209207
```
210208
211209
##### TypeScript 配置

‎README.md‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -215,11 +215,8 @@ await timber.remove()
215215

216216
```
217217
npm install @sap/hana-client
218-
npm install hdb-pool
219218
```
220219
221-
_SAP Hana support made possible by the sponsorship of [Neptune Software](https://www.neptune-software.com/)._
222-
223220
- for **Google Cloud Spanner**
224221
225222
```

‎README_ko.md‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -176,11 +176,8 @@ await timber.remove()
176176

177177
```
178178
npm i @sap/hana-client
179-
npm i hdb-pool
180179
```
181180
182-
_[Neptune Software](https://www.neptune-software.com/)의 후원으로 SAP Hana 지원이 가능해졌다._
183-
184181
- **MongoDB** (experimental)의 경우
185182
186183
`npm install mongodb@^5.2.0 --save`

‎docs/docs/data-source/2-data-source-options.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -544,6 +544,24 @@ The following TNS connection string will be used in the next explanations:
544544
- `sid` - The System Identifier (SID) identifies a specific database instance. For example, "sales".
545545
- `serviceName` - The Service Name is an identifier of a database service. For example, `sales.us.example.com`.
546546

547+
## `sap` data source options
548+
549+
- `host` - The hostname of the SAP HANA server. For example, `"localhost"`.
550+
- `port` - The port number of the SAP HANA server. For example, `30015`.
551+
- `username` - The username to connect to the SAP HANA server. For example, `"SYSTEM"`.
552+
- `password` - The password to connect to the SAP HANA server. For example, `"password"`.
553+
- `database` - The name of the database to connect to. For example, `"HXE"`.
554+
- `encrypt` - Whether to encrypt the connection. For example, `true`.
555+
- `sslValidateCertificate` - Whether to validate the SSL certificate. For example, `true`.
556+
- `key`, `cert` and `ca` - Private key, public certificate and certificate authority for the encrypted connection.
557+
- `pool` — Connection pool configuration object:
558+
- `maxConnectedOrPooled` (number) — Max active or idle connections in the pool (default: 10).
559+
- `maxPooledIdleTime` (seconds) — Time before an idle connection is closed (default: 30).
560+
- `pingCheck` (boolean) — Whether to validate connections before use (default: false).
561+
- `poolCapacity` (number) — Maximum number of connections to be kept available (default: no limit).
562+
563+
See the official documentation of SAP HANA Client for more details as well as the `extra` properties: [Node.js Connection Properties](https://help.sap.com/docs/SAP_HANA_CLIENT/f1b440ded6144a54ada97ff95dac7adf/4fe9978ebac44f35b9369ef5a4a26f4c.html).
564+
547565
## Data Source Options example
548566

549567
Here is a small example of data source options for mysql:

‎docs/docs/getting-started.md‎

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -193,18 +193,11 @@ await timber.remove()
193193

194194
- for **SAP Hana**
195195

196-
```
197-
npm install @sap/hana-client
198-
npm install hdb-pool
199-
```
200-
201-
_SAP Hana support made possible by the sponsorship of [Neptune Software](https://www.neptune-software.com/)._
196+
`npm install @sap/hana-client --save`
202197

203198
- for **Google Cloud Spanner**
204199

205-
```
206-
npm install @google-cloud/spanner --save
207-
```
200+
`npm install @google-cloud/spanner --save`
208201

209202
Provide authentication credentials to your application code
210203
by setting the environment variable `GOOGLE_APPLICATION_CREDENTIALS`:

‎package-lock.json‎

Lines changed: 1 addition & 17 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,6 @@
135135
"gulp-sourcemaps": "^3.0.0",
136136
"gulp-typescript": "^6.0.0-alpha.1",
137137
"gulpclass": "^0.2.0",
138-
"hdb-pool": "^0.1.6",
139138
"husky": "^9.1.7",
140139
"lint-staged": "^15.5.2",
141140
"mocha": "^10.8.2",
@@ -165,9 +164,8 @@
165164
},
166165
"peerDependencies": {
167166
"@google-cloud/spanner": "^5.18.0 || ^6.0.0 || ^7.0.0",
168-
"@sap/hana-client": "^2.12.25",
167+
"@sap/hana-client": "^2.14.22",
169168
"better-sqlite3": "^8.0.0 || ^9.0.0 || ^10.0.0 || ^11.0.0",
170-
"hdb-pool": "^0.1.6",
171169
"ioredis": "^5.0.4",
172170
"mongodb": "^5.8.0 || ^6.0.0",
173171
"mssql": "^9.1.1 || ^10.0.1 || ^11.0.1",
@@ -193,9 +191,6 @@
193191
"better-sqlite3": {
194192
"optional": true
195193
},
196-
"hdb-pool": {
197-
"optional": true
198-
},
199194
"ioredis": {
200195
"optional": true
201196
},

‎src/driver/sap/SapConnectionOptions.ts‎

Lines changed: 41 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,53 +19,84 @@ export interface SapConnectionOptions
1919

2020
/**
2121
* The driver objects
22-
* This defaults to require("hdb-pool")
22+
* This defaults to require("@sap/hana-client")
2323
*/
2424
readonly driver?: any
2525

2626
/**
27-
* The driver objects
28-
* This defaults to require("@sap/hana-client")
27+
* @deprecated Use {@link driver} instead.
2928
*/
3029
readonly hanaClientDriver?: any
3130

3231
/**
3332
* Pool options.
3433
*/
3534
readonly pool?: {
35+
/**
36+
* Maximum number of open connections created by the pool, each of which
37+
* may be in the pool waiting to be reused or may no longer be in the
38+
* pool and actively being used (default: 10).
39+
*/
40+
readonly maxConnectedOrPooled?: number
41+
42+
/**
43+
* Defines the maximum time, in seconds, that connections are allowed to
44+
* remain in the pool before being marked for eviction (default: 30).
45+
*/
46+
readonly maxPooledIdleTime?: number
47+
48+
/**
49+
* Determines whether or not the pooled connection should be tested for
50+
* viability before being reused (default: false).
51+
*/
52+
readonly pingCheck?: boolean
53+
54+
/**
55+
* Maximum number of connections allowed to be in the pool, waiting to
56+
* be reused (default: 0, no limit).
57+
*/
58+
readonly poolCapacity?: number
59+
3660
/**
3761
* Max number of connections.
62+
* @deprecated Use {@link maxConnectedOrPooled} instead.
3863
*/
3964
readonly max?: number
4065

4166
/**
4267
* Minimum number of connections.
68+
* @deprecated Obsolete, no alternative exists.
4369
*/
4470
readonly min?: number
4571

4672
/**
47-
* Maximum number of waiting requests allowed. (default=0, no limit).
73+
* Maximum number of waiting requests allowed.
74+
* @deprecated Obsolete, no alternative exists.
4875
*/
4976
readonly maxWaitingRequests?: number
77+
5078
/**
51-
* Max milliseconds a request will wait for a resource before timing out. (default=5000)
79+
* Max milliseconds a request will wait for a resource before timing out.
80+
* @deprecated Obsolete, no alternative exists.
5281
*/
5382
readonly requestTimeout?: number
83+
5484
/**
55-
* How often to run resource timeout checks. (default=0, disabled)
85+
* How often to run resource timeout checks.
86+
* @deprecated Obsolete, no alternative exists.
5687
*/
5788
readonly checkInterval?: number
89+
5890
/**
59-
* Idle timeout
91+
* Idle timeout (in milliseconds).
92+
* @deprecated Use {@link maxPooledIdleTime} (in seconds) instead .
6093
*/
6194
readonly idleTimeout?: number
6295

6396
/**
6497
* Function handling errors thrown by drivers pool.
65-
* Defaults to logging error with `warn` level.
98+
* @deprecated Obsolete, no alternative exists.
6699
*/
67100
readonly poolErrorHandler?: (err: any) => any
68101
}
69-
70-
readonly poolSize?: never
71102
}

0 commit comments

Comments
 (0)