PacketSize Property

SqlConnection.PacketSize Property

Gets the size (in bytes) of network packets used to communicate with an instance of SQL Server.

Namespace:  System.Data.SqlClient
Assembly:  System.Data (in System.Data.dll)

'Declaration
Public ReadOnly Property PacketSize As Integer
'Usage
Dim instance As SqlConnection 
Dim value As Integer 

value = instance.PacketSize

Property Value

Type: System.Int32
The size (in bytes) of network packets. The default value is 8000.

If an application performs bulk copy operations, or sends or receives lots of text or image data, a packet size larger than the default may improve efficiency because it causes fewer network read and write operations. If an application sends and receives small amounts of information, you can set the packet size to 512 bytes (using the Packet Size value in the ConnectionString), which is sufficient for most data transfer operations. For most applications, the default packet size is best.

PacketSize may be a value in the range of 512 and 32767 bytes. An exception is generated if the value is outside this range.

Setting the default value to a number greater than 8000 will cause the packets to use the MultiPage allocator on the instance of SQL Server instead of the much more efficient SinglePage allocator, reducing the overall scalability of the SQL Server. For more information on how SQL Server uses memory, see Memory Architecture in SQL Server Books Online.

The following example creates a SqlConnection, including setting the Packet Size to 512 in the connection string. It displays the PacketSize and ServerVersion properties in the console window.

Private Sub OpenSqlConnection()
    Dim connectionString As String = GetConnectionString()
    Using connection As New SqlConnection(connectionString)
        connection.Open()
        Console.WriteLine("ServerVersion: {0}", connection.ServerVersion)
        Console.WriteLine("PacketSize: {0}", connection.PacketSize)
    End Using 
End Sub 

Private Function GetConnectionString() As String 
    ' To avoid storing the connection string in your code,   
    ' you can retrieve it from a configuration file, using the 
    ' System.Configuration.ConfigurationSettings.AppSettings property 
    Return "Data Source=(local);Database=AdventureWorks;" _
      & "Integrated Security=SSPI;Packet Size=512;" 
End Function

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

Community Additions

ADD
Show:
© 2016 Microsoft