Skip to content

Commit

Permalink
Merge pull request #503 from kaneeldias/use-driver2
Browse files Browse the repository at this point in the history
Improve API docs on oracledb.driver usages
  • Loading branch information
kaneeldias authored Dec 1, 2022
2 parents 67eb82a + e34e171 commit feefffd
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 25 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,21 @@ Ballerina OracleDB Library
This library provides the functionality required to access and manipulate data stored in an Oracle database.

### Prerequisite
It is required to import the OracleDB driver dependencies in order to connect to a Oracle database. The `ballerinax/oracledb.driver`
package bundles the latest OracleDB drivers so that the oracledb connector can be used in Ballerina projects easily.
Add the OracleDB drivers as a dependency to the Ballerina project.

```ballerina
import ballerinax/oracledb.driver as _;
```
>**Note:** `ballerinax/oracledb` supports OracleDB driver versions above 12.2.0.1.
You can achieve this by importing the `ballerinax/oracledb.driver` module,
```ballerina
import ballerinax/oracledb.driver as _;
```

`ballerinax/oracledb.driver` package bundles the latest OracleDB driver JARs.

If it is required to use a specific Oracledb driver JARs (`ojdbc8.jar` along with `xdb.jar` and `xmlparserv2.jar`), they can be added as a native library dependencies in your
Ballerina project's `Ballerina.toml` file. It is recommended to use an oracle thin driver `ojdbc8.jar` version greater than 12.2.0.1.
>**Tip:** GraalVM native build is supported when `ballerinax/oracledb` is used along with the `ballerinax/oracledb.driver`
Follow one of the methods below to add the JAR in the file:
If you want to add a OracleDB drivers of specific versions, you can add them as a dependencies in Ballerina.toml.
Follow one of the following ways to add the JARs in the file:

* Download the JAR and update the path.
```
Expand Down
20 changes: 12 additions & 8 deletions ballerina/Module.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,21 @@
This module provides the functionality required to access and manipulate data stored in an Oracle database.

### Prerequisite
It is required to import the OracleDB driver dependencies in order to connect to a Oracle database. The `ballerinax/oracledb.driver`
package bundles the latest OracleDB drivers so that the oracledb connector can be used in Ballerina projects easily.
Add the OracleDB drivers as a dependency to the Ballerina project.

```ballerina
import ballerinax/oracledb.driver as _;
```
>**Note:** `ballerinax/oracledb` supports OracleDB driver versions above 12.2.0.1.
You can achieve this by importing the `ballerinax/oracledb.driver` module,
```ballerina
import ballerinax/oracledb.driver as _;
```

`ballerinax/oracledb.driver` package bundles the latest OracleDB driver JARs.

If it is required to use a specific Oracledb driver JARs (`ojdbc8.jar` along with `xdb.jar` and `xmlparserv2.jar`), they can be added as a native library dependencies in your
Ballerina project's `Ballerina.toml` file. It is recommended to use an oracle thin driver `ojdbc8.jar` version greater than 12.2.0.1.
>**Tip:** GraalVM native build is supported when `ballerinax/oracledb` is used along with the `ballerinax/oracledb.driver`
Follow one of the methods below to add the JAR in the file:
If you want to add a OracleDB drivers of specific versions, you can add them as a dependencies in Ballerina.toml.
Follow one of the following ways to add the JARs in the file:

* Download the JAR and update the path.
```
Expand Down
20 changes: 12 additions & 8 deletions ballerina/Package.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,21 @@
This package provides the functionality required to access and manipulate data stored in an Oracle database.

### Prerequisite
It is required to import the OracleDB driver dependencies in order to connect to a Oracle database. The `ballerinax/oracledb.driver`
package bundles the latest OracleDB drivers so that the oracledb connector can be used in Ballerina projects easily.
Add the OracleDB drivers as a dependency to the Ballerina project.

```ballerina
import ballerinax/oracledb.driver as _;
```
>**Note:** `ballerinax/oracledb` supports OracleDB driver versions above 12.2.0.1.
You can achieve this by importing the `ballerinax/oracledb.driver` module,
```ballerina
import ballerinax/oracledb.driver as _;
```

`ballerinax/oracledb.driver` package bundles the latest OracleDB driver JARs.

If it is required to use a specific Oracledb driver JARs (`ojdbc8.jar` along with `xdb.jar` and `xmlparserv2.jar`), they can be added as a native library dependencies in your
Ballerina project's `Ballerina.toml` file. It is recommended to use an oracle thin driver `ojdbc8.jar` version greater than 12.2.0.1.
>**Tip:** GraalVM native build is supported when `ballerinax/oracledb` is used along with the `ballerinax/oracledb.driver`
Follow one of the methods below to add the JAR in the file:
If you want to add a OracleDB drivers of specific versions, you can add them as a dependencies in Ballerina.toml.
Follow one of the following ways to add the JARs in the file:

* Download the JAR and update the path.
```
Expand Down
2 changes: 1 addition & 1 deletion changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Added

### Changed
- [Updated API Docs to use `oracledb.driver`](https://github.com/ballerina-platform/ballerina-standard-library/issues/3710)
- [Updated API Docs on `oracledb.driver` usages](https://github.com/ballerina-platform/ballerina-standard-library/issues/3710)

## [1.6.0] - 2022-11-29

Expand Down

0 comments on commit feefffd

Please sign in to comment.