Skip to content

Commit

Permalink
Merge pull request #1016 from daneshk/main
Browse files Browse the repository at this point in the history
Fix broken links in API Docs
  • Loading branch information
niveathika authored Aug 27, 2024
2 parents f2a8f91 + 7a26830 commit bb6c299
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 22 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Follow one of the following ways to add the JAR in the file:

### Client
To access a database, you must first create a
[`postgresql:Client`](https://docs.central.ballerina.io/ballerinax/postgresql/latest/clients/Client) object.
[`postgresql:Client`](https://docs.central.ballerina.io/ballerinax/postgresql/latest#Client) object.
The examples for creating a PostgreSQL client can be found below.

> **Tip**: The client should be used throughout the application lifetime.
Expand All @@ -67,7 +67,7 @@ postgresql:Client|sql:Error dbClient2 =
```

In the sample below, the `postgresql:Client` uses named parameters to pass the attributes since it is skipping some parameters in the constructor.
Further, the [`postgresql:Options`](https://docs.central.ballerina.io/ballerinax/postgresql/latest/records/Options)
Further, the [`postgresql:Options`](https://docs.central.ballerina.io/ballerinax/postgresql/latest#Options)
property is passed to configure the connection timeout in the PostgreSQL client.

```ballerina
Expand All @@ -80,7 +80,7 @@ postgresql:Client|sql:Error dbClient =
```

Similarly in the sample below, the `postgresql:Client` uses named parameters and it provides an unshared connection pool of the type of
[`sql:ConnectionPool`](https://docs.central.ballerina.io/ballerina/sql/latest/records/ConnectionPool)
[`sql:ConnectionPool`](https://docs.central.ballerina.io/ballerina/sql/latest#ConnectionPool)
to be used within the client.
For more details about connection pooling, see the [`sql` library](https://docs.central.ballerina.io/ballerina/sql/latest).

Expand Down Expand Up @@ -111,7 +111,7 @@ postgresql:Options postgresqlOptions = {
#### Connection pool handling

All database libraries share the same connection pooling concept and there are three possible scenarios for
connection pool handling. For its properties and possible values, see the [`sql:ConnectionPool`](https://docs.central.ballerina.io/ballerina/sql/latest/records/ConnectionPool).
connection pool handling. For its properties and possible values, see the [`sql:ConnectionPool`](https://docs.central.ballerina.io/ballerina/sql/latest#ConnectionPool).

>**Note**: Connection pooling is used to optimize opening and closing connections to the database. However, the pool comes with an overhead. It is best to configure the connection pool properties as per the application need to get the best performance.
Expand Down Expand Up @@ -158,10 +158,10 @@ connection pool handling. For its properties and possible values, see the [`sql:
database = "example", connectionPool = connPool);
```

For more details about each property, see the [`postgresql:Client`](https://docs.central.ballerina.io/ballerinax/postgresql/latest/clients/Client).
For more details about each property, see the [`postgresql:Client`](https://docs.central.ballerina.io/ballerinax/postgresql/latest#Client).

The [`postgresql:Client`](https://docs.central.ballerina.io/ballerinax/postgresql/latest/clients/Client) references
[`sql:Client`](https://docs.central.ballerina.io/ballerina/sql/latest/clients/Client) and all the operations
The [`postgresql:Client`](https://docs.central.ballerina.io/ballerinax/postgresql/latest#Client) references
[`sql:Client`](https://docs.central.ballerina.io/ballerina/sql/latest#Client) and all the operations
defined by the `sql:Client` will be supported by the `postgresql:Client` as well.

#### Close the client
Expand Down Expand Up @@ -555,6 +555,6 @@ All contributors are encouraged to read the [Ballerina Code of Conduct](https://
## Useful links

* For more information go to the [`postgresql` library](https://lib.ballerina.io/ballerinax/postgresql/latest).
* For example demonstrations of the usage, go to [Ballerina By Examples](https://ballerina.io/learn/by-example/mysql-init-options.html).
* For example demonstrations of the usage, go to [Ballerina By Examples](https://ballerina.io/learn/by-example/#database-access).
* Chat live with us via our [Discord server](https://discord.gg/ballerinalang).
* Post all technical questions on Stack Overflow with the [#ballerina](https://stackoverflow.com/questions/tagged/ballerina) tag.
14 changes: 7 additions & 7 deletions ballerina/Module.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Follow one of the following ways to add the JAR in the file:

### Client
To access a database, you must first create a
[`postgresql:Client`](https://docs.central.ballerina.io/ballerinax/postgresql/latest/clients/Client) object.
[`postgresql:Client`](https://docs.central.ballerina.io/ballerinax/postgresql/latest#Client) object.
The examples for creating a PostgreSQL client can be found below.

> **Tip**: The client should be used throughout the application lifetime.
Expand All @@ -59,7 +59,7 @@ postgresql:Client|sql:Error dbClient2 =
```

In the sample below, the `postgresql:Client` uses named parameters to pass the attributes since it is skipping some parameters in the constructor.
Further, the [`postgresql:Options`](https://docs.central.ballerina.io/ballerinax/postgresql/latest/records/Options)
Further, the [`postgresql:Options`](https://docs.central.ballerina.io/ballerinax/postgresql/latest#Options)
property is passed to configure the connection timeout in the PostgreSQL client.

```ballerina
Expand All @@ -72,7 +72,7 @@ postgresql:Client|sql:Error dbClient =
```

Similarly in the sample below, the `postgresql:Client` uses named parameters and it provides an unshared connection pool of the type of
[`sql:ConnectionPool`](https://docs.central.ballerina.io/ballerina/sql/latest/records/ConnectionPool)
[`sql:ConnectionPool`](https://docs.central.ballerina.io/ballerina/sql/latest#ConnectionPool)
to be used within the client.
For more details about connection pooling, see the [`sql` Module](https://docs.central.ballerina.io/ballerina/sql/latest).

Expand Down Expand Up @@ -103,7 +103,7 @@ postgresql:Options postgresqlOptions = {
#### Connection pool handling

All database modules share the same connection pooling concept and there are three possible scenarios for
connection pool handling. For its properties and possible values, see the [`sql:ConnectionPool`](https://docs.central.ballerina.io/ballerina/sql/latest/records/ConnectionPool).
connection pool handling. For its properties and possible values, see the [`sql:ConnectionPool`](https://docs.central.ballerina.io/ballerina/sql/latest#ConnectionPool).

>**Note**: Connection pooling is used to optimize opening and closing connections to the database. However, the pool comes with an overhead. It is best to configure the connection pool properties as per the application need to get the best performance.
Expand Down Expand Up @@ -150,10 +150,10 @@ connection pool handling. For its properties and possible values, see the [`sql:
database = "example", connectionPool = connPool);
```

For more details about each property, see the [`postgresql:Client`](https://docs.central.ballerina.io/ballerinax/postgresql/latest/clients/Client).
For more details about each property, see the [`postgresql:Client`](https://docs.central.ballerina.io/ballerinax/postgresql/latest#Client).

The [`postgresql:Client`](https://docs.central.ballerina.io/ballerinax/postgresql/latest/clients/Client) references
[`sql:Client`](https://docs.central.ballerina.io/ballerina/sql/latest/clients/Client) and all the operations
The [`postgresql:Client`](https://docs.central.ballerina.io/ballerinax/postgresql/latest#Client) references
[`sql:Client`](https://docs.central.ballerina.io/ballerina/sql/latest#Client) and all the operations
defined by the `sql:Client` will be supported by the `postgresql:Client` as well.

#### Close the client
Expand Down
14 changes: 7 additions & 7 deletions ballerina/Package.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Follow one of the following ways to add the JAR in the file:

### Client
To access a database, you must first create a
[`postgresql:Client`](https://docs.central.ballerina.io/ballerinax/postgresql/latest/clients/Client) object.
[`postgresql:Client`](https://docs.central.ballerina.io/ballerinax/postgresql/latest#Client) object.
The examples for creating a PostgreSQL client can be found below.

> **Tip**: The client should be used throughout the application lifetime.
Expand All @@ -59,7 +59,7 @@ postgresql:Client|sql:Error dbClient2 =
```

In the sample below, the `postgresql:Client` uses named parameters to pass the attributes since it is skipping some parameters in the constructor.
Further, the [`postgresql:Options`](https://docs.central.ballerina.io/ballerinax/postgresql/latest/records/Options)
Further, the [`postgresql:Options`](https://docs.central.ballerina.io/ballerinax/postgresql/latest#Options)
property is passed to configure the connection timeout in the PostgreSQL client.

```ballerina
Expand All @@ -72,7 +72,7 @@ postgresql:Client|sql:Error dbClient =
```

Similarly in the sample below, the `postgresql:Client` uses named parameters and it provides an unshared connection pool of the type of
[`sql:ConnectionPool`](https://docs.central.ballerina.io/ballerina/sql/latest/records/ConnectionPool)
[`sql:ConnectionPool`](https://docs.central.ballerina.io/ballerina/sql/latest#ConnectionPool)
to be used within the client.
For more details about connection pooling, see the [`sql` package](https://docs.central.ballerina.io/ballerina/sql/latest).

Expand Down Expand Up @@ -103,7 +103,7 @@ postgresql:Options postgresqlOptions = {
#### Connection pool handling

All database packages share the same connection pooling concept and there are three possible scenarios for
connection pool handling. For its properties and possible values, see the [`sql:ConnectionPool`](https://docs.central.ballerina.io/ballerina/sql/latest/records/ConnectionPool).
connection pool handling. For its properties and possible values, see the [`sql:ConnectionPool`](https://docs.central.ballerina.io/ballerina/sql/latest#ConnectionPool).

>**Note**: Connection pooling is used to optimize opening and closing connections to the database. However, the pool comes with an overhead. It is best to configure the connection pool properties as per the application need to get the best performance.
Expand Down Expand Up @@ -150,10 +150,10 @@ connection pool handling. For its properties and possible values, see the [`sql:
database = "example", connectionPool = connPool);
```

For more details about each property, see the [`postgresql:Client`](https://docs.central.ballerina.io/ballerinax/postgresql/latest/clients/Client).
For more details about each property, see the [`postgresql:Client`](https://docs.central.ballerina.io/ballerinax/postgresql/latest#Client).

The [`postgresql:Client`](https://docs.central.ballerina.io/ballerinax/postgresql/latest/clients/Client) references
[`sql:Client`](https://docs.central.ballerina.io/ballerina/sql/latest/clients/Client) and all the operations
The [`postgresql:Client`](https://docs.central.ballerina.io/ballerinax/postgresql/latest#Client) references
[`sql:Client`](https://docs.central.ballerina.io/ballerina/sql/latest#Client) and all the operations
defined by the `sql:Client` will be supported by the `postgresql:Client` as well.

#### Close the client
Expand Down

0 comments on commit bb6c299

Please sign in to comment.