From ca1c01dc9088202e3237f8725c88bc0b218ed192 Mon Sep 17 00:00:00 2001 From: Danesh Kuruppu Date: Sat, 24 Aug 2024 18:02:14 +0530 Subject: [PATCH 1/2] Fix broken links in API Docs --- README.md | 14 +++++++------- ballerina/Module.md | 14 +++++++------- ballerina/Package.md | 14 +++++++------- 3 files changed, 21 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 14ac269a..c15ef31c 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ Follow one of the following ways to add the JAR in the file: ### Client To access a database, you must first create an -[`mssql:Client`](https://docs.central.ballerina.io/ballerinax/mssql/latest/clients/Client) object. +[`mssql:Client`](https://docs.central.ballerina.io/ballerinax/mssql/latest#Client) object. The examples for creating an MSSQL client can be found below. > **Tip**: The client should be used throughout the application lifetime. @@ -66,7 +66,7 @@ mssql:Client|sql:Error dbClient = new( ``` The sample below shows an `mssql:Client`, which uses named parameters to pass the attributes since some parameters are skipped in the constructor. -Further, the [`mssql:Options`](https://docs.central.ballerina.io/ballerinax/mssql/latest/records/Options) +Further, the [`mssql:Options`](https://docs.central.ballerina.io/ballerinax/mssql/latest#Options) property is passed to configure the SSL and login timeout properties in the MSSQL client. ```ballerina @@ -87,7 +87,7 @@ mssql:Client|sql:Error dbClient = new( ``` Similarly, in the sample below, the `mssql:Client` uses named parameters, and it provides an unshared connection pool of the -[`sql:ConnectionPool`](https://docs.central.ballerina.io/ballerina/sql/latest/records/ConnectionPool) +[`sql:ConnectionPool`](https://docs.central.ballerina.io/ballerina/sql/latest#ConnectionPool) type to be used within the client. For more details about connection pooling, see the [`sql` library](https://docs.central.ballerina.io/ballerina/sql/latest). @@ -127,7 +127,7 @@ mssql:Options mssqlOptions = { #### Handle connection pools 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 [`sql:ConnectionPool`](https://docs.central.ballerina.io/ballerina/sql/latest/records/ConnectionPool). +connection pool handling. For its properties and possible values, see [`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. @@ -170,10 +170,10 @@ connection pool handling. For its properties and possible values, see [`sql:Conn ); ``` -For more details about each property, see the [`mssql:Client`](https://docs.central.ballerina.io/ballerinax/mssql/latest/clients/Client) constructor. +For more details about each property, see the [`mssql:Client`](https://docs.central.ballerina.io/ballerinax/mssql/latest#Client) constructor. -The [`mssql:Client`](https://docs.central.ballerina.io/ballerinax/mssql/latest/clients/Client) references -[`sql:Client`](https://docs.central.ballerina.io/ballerina/sql/latest/clients/Client) and all the operations +The [`mssql:Client`](https://docs.central.ballerina.io/ballerinax/mssql/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 `mssql:Client` as well. #### Close the client diff --git a/ballerina/Module.md b/ballerina/Module.md index f29299bb..5034a330 100644 --- a/ballerina/Module.md +++ b/ballerina/Module.md @@ -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 an -[`mssql:Client`](https://docs.central.ballerina.io/ballerinax/mssql/latest/clients/Client) object. +[`mssql:Client`](https://docs.central.ballerina.io/ballerinax/mssql/latest#Client) object. The examples for creating an MSSQL client can be found below. > **Tip**: The client should be used throughout the application lifetime. @@ -59,7 +59,7 @@ mssql:Client|sql:Error dbClient = new( ``` The sample below shows an `mssql:Client`, which uses named parameters to pass the attributes since some parameters are skipped in the constructor. -Further, the [`mssql:Options`](https://docs.central.ballerina.io/ballerinax/mssql/latest/records/Options) +Further, the [`mssql:Options`](https://docs.central.ballerina.io/ballerinax/mssql/latest#Options) property is passed to configure the SSL and login timeout properties in the MSSQL client. ```ballerina @@ -80,7 +80,7 @@ mssql:Client|sql:Error dbClient = new( ``` Similarly, in the sample below, the `mssql:Client` uses named parameters, and it provides an unshared connection pool of the -[`sql:ConnectionPool`](https://docs.central.ballerina.io/ballerina/sql/latest/records/ConnectionPool) +[`sql:ConnectionPool`](https://docs.central.ballerina.io/ballerina/sql/latest#ConnectionPool) type to be used within the client. For more details about connection pooling, see the [`sql` module](https://docs.central.ballerina.io/ballerina/sql/latest). @@ -120,7 +120,7 @@ mssql:Options mssqlOptions = { #### Handle connection pools 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 [`sql:ConnectionPool`](https://docs.central.ballerina.io/ballerina/sql/latest/records/ConnectionPool). +connection pool handling. For its properties and possible values, see [`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. @@ -163,10 +163,10 @@ connection pool handling. For its properties and possible values, see [`sql:Conn ); ``` -For more details about each property, see the [`mssql:Client`](https://docs.central.ballerina.io/ballerinax/mssql/latest/clients/Client) constructor. +For more details about each property, see the [`mssql:Client`](https://docs.central.ballerina.io/ballerinax/mssql/latest#Client) constructor. -The [`mssql:Client`](https://docs.central.ballerina.io/ballerinax/mssql/latest/clients/Client) references -[`sql:Client`](https://docs.central.ballerina.io/ballerina/sql/latest/clients/Client) and all the operations +The [`mssql:Client`](https://docs.central.ballerina.io/ballerinax/mssql/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 `mssql:Client` as well. #### Close the client diff --git a/ballerina/Package.md b/ballerina/Package.md index 68af57b5..1a5aa1c0 100644 --- a/ballerina/Package.md +++ b/ballerina/Package.md @@ -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 an -[`mssql:Client`](https://docs.central.ballerina.io/ballerinax/mssql/latest/clients/Client) object. +[`mssql:Client`](https://docs.central.ballerina.io/ballerinax/mssql/latest#Client) object. The examples for creating an MSSQL client can be found below. > **Tip**: The client should be used throughout the application lifetime. @@ -59,7 +59,7 @@ mssql:Client|sql:Error dbClient = new( ``` The sample below shows an `mssql:Client`, which uses named parameters to pass the attributes since some parameters are skipped in the constructor. -Further, the [`mssql:Options`](https://docs.central.ballerina.io/ballerinax/mssql/latest/records/Options) +Further, the [`mssql:Options`](https://docs.central.ballerina.io/ballerinax/mssql/latest#Options) property is passed to configure the SSL and login timeout properties in the MSSQL client. ```ballerina @@ -80,7 +80,7 @@ mssql:Client|sql:Error dbClient = new( ``` Similarly, in the sample below, the `mssql:Client` uses named parameters, and it provides an unshared connection pool of the -[`sql:ConnectionPool`](https://docs.central.ballerina.io/ballerina/sql/latest/records/ConnectionPool) +[`sql:ConnectionPool`](https://docs.central.ballerina.io/ballerina/sql/latest#ConnectionPool) type to be used within the client. For more details about connection pooling, see the [`sql` Package](https://docs.central.ballerina.io/ballerina/sql/latest). @@ -120,7 +120,7 @@ mssql:Options mssqlOptions = { #### Handle connection pools 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 [`sql:ConnectionPool`](https://docs.central.ballerina.io/ballerina/sql/latest/records/ConnectionPool). +connection pool handling. For its properties and possible values, see [`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. @@ -163,10 +163,10 @@ connection pool handling. For its properties and possible values, see [`sql:Conn ); ``` -For more details about each property, see the [`mssql:Client`](https://docs.central.ballerina.io/ballerinax/mssql/latest/clients/Client) constructor. +For more details about each property, see the [`mssql:Client`](https://docs.central.ballerina.io/ballerinax/mssql/latest#Client) constructor. -The [`mssql:Client`](https://docs.central.ballerina.io/ballerinax/mssql/latest/clients/Client) references -[`sql:Client`](https://docs.central.ballerina.io/ballerina/sql/latest/clients/Client) and all the operations +The [`mssql:Client`](https://docs.central.ballerina.io/ballerinax/mssql/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 `mssql:Client` as well. #### Close the client From c20dcb8e5be6e4c156bf51f11229b41c8865df30 Mon Sep 17 00:00:00 2001 From: Danesh Kuruppu Date: Sat, 24 Aug 2024 18:14:32 +0530 Subject: [PATCH 2/2] add example link --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index c15ef31c..39199ae8 100644 --- a/README.md +++ b/README.md @@ -569,5 +569,6 @@ All contributors are encouraged to read the [Ballerina code of conduct](https:// ## Useful links * For more information go to the [`MSSQL` library](https://lib.ballerina.io/ballerinax/mssql/latest). +* 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.