CFLib.org – Common Function Library Project

Description:
Gets the configuration of an existing datasource.

Return Values:
Returns a structure.

Example:

<cfset dsStructure = getDSN("mydatasource")>
<cfdump var="#dsStructure#">

Parameters:

Full UDF Source:

<!---
 Gets the configuration of an existing datasource.
 
 @param dsn      The name of the datasource. (Required)
 @return Returns a structure. 
 @author Martin Parry (martin.parry@beetrootstreet.com) 
 @version 1, January 6, 2004 
--->
<cffunction name="getdsn" returntype="struct" output="false">
    <cfargument name="dsn" type="string" required="yes">

    <!--- initialize variables --->
    <cfset var dsservice = "">

    <!--- get "factory" --->
    <cfobject action="create"
             type="java"
             class="coldfusion.server.ServiceFactory"
             name="factory">

    <!--- get datasource service --->
    <cfset dsservice = factory.getdatasourceservice()>

    <cfif not structKeyExists(dsservice.datasources,dsn)>
        <cfthrow message="#dsn# is not a registered datasource.">
    </cfif>
    
    <!--- get dsn --->
    <cfreturn duplicate(dsservice.datasources[dsn])>

</cffunction>