SqlDataDictionary Class

Definition

The SqlDataDictionary class provides a collection of methods for data dictionary maintenance.

public ref class SqlDataDictionary : Microsoft::Dynamics::Ax::Xpp::XppObjectBase
[Microsoft.Dynamics.Ax.Xpp.KernelClass]
public class SqlDataDictionary : Microsoft.Dynamics.Ax.Xpp.XppObjectBase
[<Microsoft.Dynamics.Ax.Xpp.KernelClass>]
type SqlDataDictionary = class
    inherit XppObjectBase
Public Class SqlDataDictionary
Inherits XppObjectBase
Inheritance
Microsoft.Dynamics.AX.KernelInterop.ProxyBase
SqlDataDictionary
Attributes

Remarks

This API has a built-in authorization check that is invoked at run time. Calls to members of the SQLDataDictionary class by users without access to the development security key (SysDevelopment) results in an exception.

The following example checks whether the UserInfo table exists in the database.

server static public void Main(Args _args) 
{ 
    SqlDataDictionary sqlDict; 
    boolean b; 
    sqlDict = new SqlDataDictionary(); 
    if (sqlDict) 
    { 
        b = sqlDict.tableExist("USERINFO"); 
        print b; 
        pause; 
    } 
}

Constructors

SqlDataDictionary()
SqlDataDictionary(IntPtr)

Fields

__k_SqlDataDictionaryId
kernelClass (Inherited from XppObjectBase)

Methods

__shouldCallNew(Type)
addXppProxyReference(Type, Object) (Inherited from XppObjectBase)
Call(String, Object[], Type[], Object[]) (Inherited from XppObjectBase)
cancelTimeOut(Int32) (Inherited from XppObjectBase)
createKernelClass(Object[], Type[], Object[]) (Inherited from XppObjectBase)
equal(XppObjectBase) (Inherited from XppObjectBase)
finalize() (Inherited from XppObjectBase)
GetIntPtr() (Inherited from XppObjectBase)
GetKernelInstanceUniqueId() (Inherited from XppObjectBase)
getTimeOutTimerHandle() (Inherited from XppObjectBase)
getXppProxyReference(Type) (Inherited from XppObjectBase)
handle()
indexCreate()

Creates the indexes of a table in the SQL database. You can also use this method to re-create indexes.

indexCreate(Int32)
indexCreate(Int32, Int32)
indexCreateDDL(Int32)

Generates and returns the SQL statements needed to create the indexes of a table.

indexDrop()

Drops the indexes of a table in the SQL database.

indexDrop(Int32)
indexDrop(Int32, Int32)
indexDrop(Int32, Int32, Boolean)
IsManagedValid() (Inherited from XppObjectBase)
kernelhandle()
KernelInstanceDisposed() (Inherited from XppObjectBase)
MakeReflectionCall(String, Object[]) (Inherited from XppObjectBase)
name(String)

Translates any object name into a valid SQL database object-name; that is, valid for the database currently connected.

name(String, Int32)
name(String, Int32, Int32)
newmethod()

Initializes a new instance of the SqlDataDictionary class.

notify() (Inherited from XppObjectBase)
notifyAll() (Inherited from XppObjectBase)
objectOnServer()
Obsolete.
(Inherited from XppObjectBase)
setTimeOut(String, Int32)
Obsolete.
(Inherited from XppObjectBase)
setTimeOut(String, Int32, Boolean)
Obsolete.
(Inherited from XppObjectBase)
synchronize()

Synchronizes the data dictionary and the data dictionary of the SQL database.

synchronize(Boolean)
tableCreate()

Creates one or more tables in the SQL database. Also, provides an option to create for index.

tableCreate(Boolean)
tableCreate(Boolean, Int32)
tableCreateDDL(Int32)

Generates and returns the SQL statement to create a table.

tableDelete(Int32)

Deletes the table in the SQL database.

tableDrop(Int32)

Drops the table in the SQL database.

tableDrop(Int32, Boolean)
tableDropDDL(Int32)

Generates and returns the SQL statement to drop a table.

tableEmpty(Int32)

Returns true if table is not empty; otherwise false.

tableEmpty(Int32, String)
tableEmpty(Int32, String, Boolean)
tableExist(String)

Returns true if table exists; otherwise false.

tableExist(String, Boolean)
tableMetaData(Int32)

Fills the SqlDescribe table with data dictionary meta data.

tableReindex()

Updates index for the table.

tableReindex(Int32)
tableReindex(Int32, Int32)
tableSynchronize(Int32)

Synchronizes the table and the table of the SQL database.

tableSynchronize(Int32, Boolean)
tableSynchronize(Int32, Boolean, Boolean)
tableTruncate(Int32)

Truncates the table.

tableTruncate(Int32, Boolean)
tableTruncate(Int32, Boolean, Boolean)
tableTruncateDDL(Int32)

Generates and returns a SQL statement to truncate a table.

usageCount() (Inherited from XppObjectBase)
VerifyKernelClass() (Inherited from XppObjectBase)
wait() (Inherited from XppObjectBase)
Xml() (Inherited from XppObjectBase)
Xml(Int32) (Inherited from XppObjectBase)

Applies to