Package ortus.boxlang.runtime.components.jdbc

Class DBInfo

java.lang.Object

ortus.boxlang.runtime.components.Component

ortus.boxlang.runtime.components.jdbc.DBInfo

@BoxComponent(allowsBody=false)
public class DBInfo
extends Component

Nested Class Summary

Nested classes/interfaces inherited from class ortus.boxlang.runtime.components.Component

Component.BodyResult, Component.ComponentBody

Field Summary

Fields inherited from class ortus.boxlang.runtime.components.Component

componentService, declaredAttributes, DEFAULT_RETURN, functionService, interceptorService, name, runtime

Constructor Summary

Constructors

Constructor	Description
DBInfo()	Constructor

Method Summary

Modifier and Type	Method	Description
Component.BodyResult	_invoke(IBoxContext context, IStruct attributes, Component.ComponentBody body, IStruct executionState)	Retrieve database metadata for a given datasource.

Methods inherited from class ortus.boxlang.runtime.components.Component

announce, getDeclaredAttributes, getName, invoke, processBody, processBody, setName, validateAttributes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DBInfo

public DBInfo()

Constructor

Method Details

_invoke

public Component.BodyResult _invoke(IBoxContext context,
 IStruct attributes,
 Component.ComponentBody body,
 IStruct executionState)

Retrieve database metadata for a given datasource. This can include: column metadata, database names, table names, foreign keys, index info, stored procedures, and version info.

Please note that the type attribute is required, and the name attribute is required to store the result.

Specified by:

_invoke in class Component

Parameters:

context - The context in which the Component is being invoked

attributes - The attributes to the Component

body - The body of the Component

executionState - The execution state of the Component

Returns:

The result of the invocation