Database.PrefetchObjects Database.PrefetchObjects Database.PrefetchObjects Method

Definition

Prefetches database objects.

Overloads

PrefetchObjects() PrefetchObjects() PrefetchObjects()

Prefetches database objects.

PrefetchObjects(Type, ScriptingOptions) PrefetchObjects(Type, ScriptingOptions)

Prefetches database objects of a specified type with scripting options.

PrefetchObjects(Type) PrefetchObjects(Type) PrefetchObjects(Type)

Prefetches database objects of a specified type.

PrefetchObjects() PrefetchObjects() PrefetchObjects()

Prefetches database objects.

public:
 void PrefetchObjects();
public void PrefetchObjects ();
Public Sub PrefetchObjects ()

Examples

VB

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

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

'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)  

PowerShell

$srv = new-Object Microsoft.SqlServer.Management.Smo.Server("(local)")  
$db = New-Object Microsoft.SqlServer.Management.Smo.Database  
$db = $srv.Databases.Item("AdventureWorks2012")  

$tb = New-Object Microsoft.SqlServer.Management.Smo.Table  
$typ = $tb.GetType()  

$so = New-Object Microsoft.SqlServer.Management.Smo.ScriptingOptions  
$so.AllowSystemObjects = $TRUE  

$db.PrefetchObjects($typ, $so)  

Write-Host $db.GetTransactionCount()  

Remarks

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

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

PrefetchObjects(Type, ScriptingOptions) PrefetchObjects(Type, ScriptingOptions)

Prefetches database objects of a specified type with scripting options.

public:
 void PrefetchObjects(Type ^ objectType, Microsoft::SqlServer::Management::Smo::ScriptingOptions ^ scriptingOptions);
public void PrefetchObjects (Type objectType, Microsoft.SqlServer.Management.Smo.ScriptingOptions scriptingOptions);
Parameters
objectType
Type Type Type

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

scriptingOptions
ScriptingOptions ScriptingOptions ScriptingOptions

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

Examples

VB

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

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

'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)  

PowerShell

$srv = new-Object Microsoft.SqlServer.Management.Smo.Server("(local)")  
$db = New-Object Microsoft.SqlServer.Management.Smo.Database  
$db = $srv.Databases.Item("AdventureWorks2012")  

$tb = New-Object Microsoft.SqlServer.Management.Smo.Table  
$typ = $tb.GetType()  

$so = New-Object Microsoft.SqlServer.Management.Smo.ScriptingOptions  
$so.AllowSystemObjects = $TRUE  

$db.PrefetchObjects($typ, $so)  

Write-Host $db.GetTransactionCount()  

Remarks

This lets collections be fully populated with objects by making one network trip to the instance of 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.

PrefetchObjects(Type) PrefetchObjects(Type) PrefetchObjects(Type)

Prefetches database objects of a specified type.

public:
 void PrefetchObjects(Type ^ objectType);
public void PrefetchObjects (Type objectType);
Public Sub PrefetchObjects (objectType As Type)
Parameters
objectType
Type Type Type

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

Examples

VB

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

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

'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)  

PowerShell

$srv = new-Object Microsoft.SqlServer.Management.Smo.Server("(local)")  
$db = New-Object Microsoft.SqlServer.Management.Smo.Database  
$db = $srv.Databases.Item("AdventureWorks2012")  

$tb = New-Object Microsoft.SqlServer.Management.Smo.Table  
$typ = $tb.GetType()  

$so = New-Object Microsoft.SqlServer.Management.Smo.ScriptingOptions  
$so.AllowSystemObjects = $TRUE  

$db.PrefetchObjects($typ, $so)  

Write-Host $db.GetTransactionCount()  

Remarks

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

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

Applies to