sp_getdefaultdatatypemapping (Transact-SQL)

APPLIES TO: yesSQL Server (starting with 2008) noAzure SQL Database noAzure SQL Data Warehouse noParallel Data Warehouse

Returns information on the default mapping for the specified data type between Microsoft SQL Server and a non- SQL Server database management system (DBMS). This stored procedure is executed at the Distributor on any database.

Topic link icon Transact-SQL Syntax Conventions

Syntax


sp_getdefaultdatatypemapping [ @source_dbms = ] 'source_dbms'   
    [ , [ @source_version = ] 'source_version' ]  
        , [ @source_type = ] 'source_type'    
    [ , [ @source_length = ] source_length ]  
    [ , [ @source_precision = ] source_precision ]  
    [ , [ @source_scale = ] source_scale ]  
    [ , [ @source_nullable = ] source_nullable ]  
        , [ @destination_dbms = ] 'destination_dbms'   
    [ , [ @destination_version = ] 'destination_version' ]  
    [ , [ @destination_type = ] 'destination_type' OUTPUT ]  
    [ , [ @destination_length = ] destination_length OUTPUT ]  
    [ , [ @destination_precision = ] destination_precision OUTPUT ]  
    [ , [ @destination_scale = ] destination_scale OUTPUT ]  
    [ , [ @destination_nullable = ] source_nullable OUTPUT ]  
    [ , [ @dataloss = ] dataloss OUTPUT ]  

Arguments

[ @source_dbms= ] 'source_dbms'
Is the name of the DBMS from which the data types are mapped. source_dbms is sysname, and can be one of the following values:

Value Description
MSSQLSERVER The source is a SQL Server database.
ORACLE The source is an Oracle database.

You must specify this parameter.

[ @source_version= ] 'source_version'
Is the version number of the source DBMS. source_version is varchar(10), with a default value of NULL.

[ @source_type= ] 'source_type'
Is the data type in the source DBMS. source_type is sysname, with no default.

[ @source_length= ] source_length
Is the length of the data type in the source DBMS. source_length is bigint, with a default value of NULL.

[ @source_precision= ] source_precision
Is the precision of the data type in the source DBMS. source_precision is bigint, with a default value of NULL.

[ @source_scale= ] source_scale
Is the scale of the data type in the source DBMS. source_scale is int, with a default value of NULL.

[ @source_nullable= ] source_nullable
Is if the data type in the source DBMS supports a value of NULL. source_nullable is bit, with a default value of 1, which means that NULL values are supported.

[ @destination_dbms = ] 'destination_dbms'
Is the name of the destination DBMS. destination_dbms is sysname, and can be one of the following values:

Value Description
MSSQLSERVER The destination is a SQL Server database.
ORACLE The destination is an Oracle database.
DB2 The destination is an IBM DB2 database.
SYBASE The destination is a Sybase database.

You must specify this parameter.

[ @destination_version= ] 'destination_version'
Is the product version of the destination DBMS. destination_version is varchar(10), with a default value of NULL.

[ @destination_type= ] 'destination_type' OUTPUT
Is the data type listed in the destination DBMS. destination_type is sysname, with a default value of NULL.

[ @destination_length= ] destination_length OUTPUT
Is the length of the data type in the destination DBMS. destination_length is bigint, with a default value of NULL.

[ @destination_precision= ] destination_precision OUTPUT
Is the precision of the data type in the destination DBMS. destination_precision is bigint, with a default value of NULL.

[ @destination_scale= ] destination_scaleOUTPUT
Is the scale of the data type in the destination DBMS. destination_scale is int, with a default value of NULL.

[ @destination_nullable= ] destination_nullableOUTPUT
Is if the data type in the destination DBMS supports a value of NULL. destination_nullable is bit, with a default value of NULL. 1 means that NULL values are supported.

[ @dataloss= ] datalossOUTPUT
Is if the mapping has the potential for data loss. dataloss is bit, with a default value of NULL. 1 means that there is a potential for data loss.

Return Code Values

0 (success) or 1 (failure)

Remarks

sp_getdefaultdatatypemapping is used in all types of replication between SQL Server and a non- SQL Server DBMS.

sp_getdefaultdatatypemapping returns the default destination data type that is the closest match to the specified source data type.

Permissions

Only members of the sysadmin fixed server role can execute sp_getdefaultdatatypemapping.

See Also

sp_helpdatatypemap (Transact-SQL)
sp_setdefaultdatatypemapping (Transact-SQL)
Data Type Mapping for Oracle Publishers
IBM DB2 Subscribers
Oracle Subscribers