Export (0) Print
Expand All

Database.PrefetchObjects Method (Type, ScriptingOptions)

Prefetches database objects of a specified type with scripting options.

Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.Smo (in microsoft.sqlserver.smo.dll)

public void PrefetchObjects (
	Type objectType,
	ScriptingOptions scriptingOptions
)
public void PrefetchObjects (
	Type objectType, 
	ScriptingOptions scriptingOptions
)
public function PrefetchObjects (
	objectType : Type, 
	scriptingOptions : ScriptingOptions
)

Parameters

objectType

A Type object that limits the type of object that is prefetched.

scriptingOptions

A ScriptingOptions object value that specifies the scripting options for the prefetched database object.

Updated text: 17 July 2006

This lets collections be fully populated with objects with one network trip to the instance of Microsoft SQL Server. Prefetching is an optimization used when the whole collection of objects is required.

This method uses the scripting initialization of fields for prefetching database objects.

This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.


'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server

'Reference the AdventureWorks database.
Dim db As Database
db = srv.Databases("AdventureWorks")

'Assign the Table object type to a System.Type object variable.
Dim tb As Table
Dim typ As Type
tb = New Table
typ = tb.GetType

'Set scripting options.
Dim so As ScriptingOptions
so = New ScriptingOptions
so.AllowSystemObjects = True

'Prefetch all Table type objects, including system objects.
db.PrefetchObjects(typ, so)

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

Release

History

17 July 2006

Changed content:
  • Added text to the Remarks section.

  • Added code to the Example section.

Community Additions

ADD
Show:
© 2014 Microsoft