ballerina/jdbc package

Primitives Summary

Type Description

Type Definitions

Type Values Description

Annotations

Name Attachement Points Data Type Description

Objects Summary

Object Description
ClientEndpointConfiguration
The Client endpoint configuration for SQL databases.

Endpoints Summary

Endpoint Description

Functions Summary

Return Type Function and Description
CallerActions createClient(ClientEndpointConfiguration config)

Global Variables

Name Data Type Description

public object ClientEndpointConfiguration

The Client endpoint configuration for SQL databases.

Field Name Data Type Default Value Description
url string
  • URL of the database to connect.
username string
  • Username for the database connection.
password string
  • Password for the database connection.
poolOptions PoolOptions
  • Properties for the connection pool configuration.
dbOptions map
  • Data source specific properties which are used along with the dataSourceClassName.

public function createClient(ClientEndpointConfiguration config) returns (CallerActions)

Parameter Name Data Type Default Value Description
config ClientEndpointConfiguration
Return Type Description
CallerActions

public type Client object

Represents an JDBC SQL client endpoint.

  • <Client> getCallerActions() returns (CallerActions)

        Returns the connector that the client code uses.
    

    Return Type Description
    CallerActions
  • <Client> stop()

        Stops the JDBC client.