restEnabledSqlDatabase

Direct Properties:

PropertyTypeRequiredDefault ValueDetails
namestringYesdata type=string; maxLen=255
Enter a descriptive name for this REST Enabled SQL Service.

Property Groups:

  • endpointUrl
  • authentication
  • database
  • databaseSession
  • session
  • dynamicConfig
  • advanced
  • comments
endpointUrl
PropertyTypeRequiredDefault ValueDetails
urlstringYesdata type=string; maxLen=4000
Enter the endpoint URL for this REST Enabled SQL Service. Include the ORDS context root and schema URL prefix, e.g. https://{host}:{port}/ords/{schema}. Do not append /_/sql; Application Express will take care of that.
 
endpointUrl {
  url: value
}
authentication
PropertyTypeRequiredDefault ValueDetails
credentialsreferenceYesdata type=reference; lov=COMPONENT; references=webCredential
 
authentication {
  credentials: @component
}
database
PropertyTypeRequiredDefault ValueDetails
databaseTypeenumNodata type=string; lov=STATIC
Valid values: oracle mysql
databaseInfomultiline stringNodata type=multiline string; maxLen=4000
Applies whendatabaseType is set
 
database {
  databaseType: oracle
  databaseInfo: ```
    value
  ```
}
databaseSession
PropertyTypeRequiredDefault ValueDetails
initPlsqlCodemultiline stringNodata type=multiline string; maxLen=4000
Enter code to be executed immediately after connecting to the REST Enabled SQL Service and before the component SQL is being executed.
cleanupPlsqlCodemultiline stringNodata type=multiline string; maxLen=4000
Enter code to be executed immediately after the component SQL is being executed.
 
databaseSession {
  initPlsqlCode: ```plsql
    value
  ```
  cleanupPlsqlCode: ```plsql
    value
  ```
}
session
PropertyTypeRequiredDefault ValueDetails
defaultSchemastringNodata type=string; maxLen=255
Applies whendatabaseType = mysql
mysqlSqlModesstringNodata type=string; maxLen=4000
Applies whendatabaseType = mysql
 
session {
  defaultSchema: value
  mysqlSqlModes: value
}
dynamicConfig
PropertyTypeRequiredDefault ValueDetails
plsqlCodemultiline stringNodata type=multiline string; maxLen=32000

A procedure which configures the Endpoint URL at runtime can be defined here.

procedureNamestringNodata type=string; maxLen=255

Enter the name of a procedure which configures the Endpoint URL at runtime. This can be a stored procedure or a procedure defined in item PL/SQL Code. The code below is for an application that implements multi-tenancy and supports different variations of Endpoint URL for the tenants. It changes the domain name in the URL, depending on the customer (Example URLs: https://cust-01.example.com, https://cust-02.example.com): 

dynamicConfig {
  plsqlCode: ```plsql
    value
  ```
  procedureName: value
}
advanced
PropertyTypeRequiredDefault ValueDetails
staticIdstringYesdata type=string; maxLen=255
Use the Static ID to reference the REST Enabled SQL Service in API Calls. Static IDs are also used to identify an existing REST Enabled SQL Service when the application is being exported and imported to another workspace.
promptOnInstallbooleanYesfalsedata type=boolean
Choose whether prompts for this REST Enabled SQL Service should be displayed when the application is being imported on another Application Express instance.
httpsHostNamestringNodata type=string; maxLen=500
The host name to be matched against the common name (CN) of the remote server's certificate for an HTTPS request. It can also be a domain name like *.example.com. If NULL, the host name in the given URL will be used.
ordsVersionstringNodata type=string; maxLen=255
serverTimeZonestringNodata type=string; maxLen=255
 
advanced {
  staticId: value
  promptOnInstall: false
  httpsHostName: value
  ordsVersion: value
  serverTimeZone: value
}
comments
PropertyTypeRequiredDefault ValueDetails
commentsmultiline stringNodata type=multiline string; maxLen=4000
 
comments {
  comments: ```
    value
  ```
}

APEXlang Example

restEnabledSqlDatabase sample (
    name: value
    endpointUrl {
        url: value
    }
    authentication {
        credentials: @component
    }
    database {
        databaseType: oracle
        databaseInfo: ```
          value
        ```
    }
    databaseSession {
        initPlsqlCode: ```plsql
          value
        ```
        cleanupPlsqlCode: ```plsql
          value
        ```
    }
    session {
        defaultSchema: value
        mysqlSqlModes: value
    }
    dynamicConfig {
        plsqlCode: ```plsql
          value
        ```
        procedureName: value
    }
    advanced {
        staticId: value
        promptOnInstall: false
        httpsHostName: value
        ordsVersion: value
        serverTimeZone: value
    }
    comments {
        comments: ```
          value
        ```
    }
)