FILESTREAM (SQL Server)
FILESTREAM enables SQL Server-based applications to store unstructured data, such as documents and images, on the file system. Applications can leverage the rich streaming APIs and performance of the file system and at the same time maintain transactional consistency between the unstructured data and corresponding structured data.
FILESTREAM integrates the SQL Server Database Engine with an NTFS or ReFS file systems by storing varbinary(max) binary large object (BLOB) data as files on the file system. Transact-SQL statements can insert, update, query, search, and back up FILESTREAM data. Win32 file system interfaces provide streaming access to the data.
FILESTREAM uses the NT system cache for caching file data. This helps reduce any effect that FILESTREAM data might have on Database Engine performance. The SQL Server buffer pool is not used; therefore, this memory is available for query processing.
FILESTREAM is not automatically enabled when you install or upgrade SQL Server. You must enable FILESTREAM by using SQL Server Configuration Manager and SQL Server Management Studio. To use FILESTREAM, you must create or modify a database to contain a special type of filegroup. Then, create or modify a table so that it contains a varbinary(max) column with the FILESTREAM attribute. After you complete these tasks, you can use Transact-SQL and Win32 to manage the FILESTREAM data.
When to Use FILESTREAM
In SQL Server, BLOBs can be standard varbinary(max) data that stores the data in tables, or FILESTREAM varbinary(max) objects that store the data in the file system. The size and use of the data determines whether you should use database storage or file system storage. If the following conditions are true, you should consider using FILESTREAM:
- Objects that are being stored are, on average, larger than 1 MB.
- Fast read access is important.
- You are developing applications that use a middle tier for application logic.
For smaller objects, storing varbinary(max) BLOBs in the database often provides better streaming performance.
FILESTREAM storage is implemented as a varbinary(max) column in which the data is stored as BLOBs in the file system. The sizes of the BLOBs are limited only by the volume size of the file system. The standard varbinary(max) limitation of 2-GB file sizes does not apply to BLOBs that are stored in the file system.
To specify that a column should store data on the file system, specify the FILESTREAM attribute on a varbinary(max) column. This causes the Database Engine to store all data for that column on the file system, but not in the database file.
FILESTREAM data must be stored in FILESTREAM filegroups. A FILESTREAM filegroup is a special filegroup that contains file system directories instead of the files themselves. These file system directories are called data containers. Data containers are the interface between Database Engine storage and file system storage.
When you use FILESTREAM storage, consider the following:
- When a table contains a FILESTREAM column, each row must have a nonnull unique row ID.
- Multiple data containers can be added to a FILESTREAM filegroup.
- FILESTREAM data containers cannot be nested.
- When you are using failover clustering, the FILESTREAM filegroups must be on shared disk resources.
- FILESTREAM filegroups can be on compressed volumes.
Because FILESTREAM is implemented as a varbinary(max) column and integrated directly into the Database Engine, most SQL Server management tools and functions work without modification for FILESTREAM data. For example, you can use all backup and recovery models with FILESTREAM data, and the FILESTREAM data is backed up with the structured data in the database. If you do not want to back up FILESTREAM data with relational data, you can use a partial backup to exclude FILESTREAM filegroups.
In SQL Server, FILESTREAM data is secured just like other data is secured: by granting permissions at the table or column levels. If a user has permission to the FILESTREAM column in a table, the user can open the associated files.
Encryption is not supported on FILESTREAM data.
Only the account under which the SQL Server service account runs is granted permissions to the FILESTREAM container. We recommend that no other account be granted permissions on the data container.
SQL logins will not work with FILESTREAM containers. Only NTFS or ReFS authentication will work with FILESTREAM containers.
Accessing BLOB Data with Transact-SQL and File System Streaming Access
After you store data in a FILESTREAM column, you can access the files by using Transact-SQL transactions or by using Win32 APIs.
By using Transact-SQL, you can insert, update, and delete FILESTREAM data:
- You can use an insert operation to prepopulate a FILESTREAM field with a null value, empty value, or relatively short inline data. However, a large amount of data is more efficiently streamed into a file that uses Win32 interfaces.
- When you update a FILESTREAM field, you modify the underlying BLOB data in the file system. When a FILESTREAM field is set to NULL, the BLOB data associated with the field is deleted. You cannot use a Transact-SQL chunked update, implemented as UPDATE.Write(), to perform partial updates to the data.
- When you delete a row or delete or truncate a table that contains FILESTREAM data, you delete the underlying BLOB data in the file system.
File System Streaming Access
The Win32 streaming support works in the context of a SQL Server transaction. Within a transaction, you can use FILESTREAM functions to obtain a logical UNC file system path of a file. You then use the OpenSqlFilestream API to obtain a file handle. This handle can then be used by Win32 file streaming interfaces, such as ReadFile() and WriteFile(), to access and update the file by way of the file system.
Because file operations are transactional, you cannot delete or rename FILESTREAM files through the file system.
The FILESTREAM file system access models a Transact-SQL statement by using file open and close. The statement starts when a file handle is opened and ends when the handle is closed. For example, when a write handle is closed, any possible AFTER trigger that is registered on the table fires as if an UPDATE statement is completed.
In FILESTREAM, the Database Engine controls the BLOB physical file system namespace. A new intrinsic function, PathName, provides the logical UNC path of the BLOB that corresponds to each FILESTREAM cell in the table. The application uses this logical path to obtain the Win32 handle and operate on the BLOB data by using regular Win32 file system interfaces. The function returns NULL if the value of the FILESTREAM column is NULL.
Transacted File System Access
A new intrinsic function, GET_FILESTREAM_TRANSACTION_CONTEXT(), provides the token that represents the current transaction that the session is associated with. The transaction must have been started and not yet aborted or committed. By obtaining a token, the application binds the FILESTREAM file system streaming operations with a started transaction. The function returns NULL in case of no explicitly started transaction.
All file handles must be closed before the transaction commits or aborts. If a handle is left open beyond the transaction scope, additional reads against the handle will cause a failure; additional writes against the handle will succeed, but the actual data will not be written to disk. Similarly, if the database or instance of the Database Engine shuts down, all open handles are invalidated.
With FILESTREAM, upon transaction commit, the Database Engine ensures transaction durability for FILESTREAM BLOB data that is modified from the file system streaming access.
The isolation semantics are governed by Database Engine transaction isolation levels. Read-committed isolation level is supported for Transact-SQL and file system access. Repeatable read operations, and also serializable and snapshot isolations, are supported. Dirty read is not supported.
The file system access open operations do not wait for any locks. Instead, the open operations fail immediately if they cannot access the data because of transaction isolation. The streaming API calls fail with ERROR_SHARING_VIOLATION if the open operation cannot continue because of isolation violation.
To allow for partial updates to be made, the application can issue a device FS control (FSCTL_SQL_FILESTREAM_FETCH_OLD_CONTENT) to fetch the old content into the file that the opened handle references. This will trigger a server-side old content copy. For better application performance and to avoid running into potential time-outs when you are working with very large files, we recommend that you use asynchronous I/O.
If the FSCTL is issued after the handle has been written to, the last write operation will persist, and prior writes that were made to the handle are lost.
File System APIs and Supported Isolation Levels
When a file system API cannot open a file because of an isolation violation, an ERROR_SHARING_VIOLATION exception is returned. This isolation violation occurs when two transactions try to access the same file. The outcome of the access operation depends on the mode the file was opened in and the version of SQL Server that the transaction is running on. The following table outlines the possibly outcomes for two transactions that are accessing the same file.
|Transaction 1||Transaction 2||Outcome on SQL Server 2008||Outcome on SQL Server 2008 R2 and later versions|
|Open for read.||Open for read.||Both succeed.||Both succeed.|
|Open for read.||Open for write.||Both succeed. Write operations under transaction 2 do not affect read operations performed in transaction 1.||Both succeed. Write operations under transaction 2 do not affect read operations performed in transaction 1.|
|Open for write.||Open for read.||Open for transaction 2 fails with an ERROR_SHARING_VIOLATION exception.||Both succeed.|
|Open for write.||Open for write.||Open for transaction 2 fails with an ERROR_SHARING_VIOLATION exception.||Open for transaction 2 fails with an ERROR_SHARING_VIOLATION exception.|
|Open for read.||Open for SELECT.||Both succeed.||Both succeed.|
|Open for read.||Open for UPDATE or DELETE.||Both succeed. Write operations under transaction 2 do not affect read operations performed in transaction 1.|
|Open for write.||open for SELECT.||Transaction 2 blocks until transaction 1 commits or ends the transaction, or the transaction lock times out.||Both succeed.|
|Open for write.||Open for UPDATE or DELETE.||Transaction 2 blocks until transaction 1 commits or ends the transaction, or the transaction lock times out.||Transaction 2 blocks until transaction 1 commits or ends the transaction, or the transaction lock times out.|
|Open for SELECT.||Open for read.||Both succeed.||Both succeed.|
|Open for SELECT.||Open for write.||Both succeed. Write operations under transaction 2 do not affect transaction 1.||Both succeed. Write operations under transaction 2 do not affect transaction 1.|
|Open for UPDATE or DELETE.||Open for read.||The open operation on transaction 2 fails with an ERROR_SHARING_VIOLATION exception.||Both succeed.|
|Open for UPDATE or DELETE.||Open for write.||The open operation on transaction 2 fails with an ERROR_SHARING_VIOLATION exception.||The open operation on transaction 2 fails with an ERROR_SHARING_VIOLATION exception.|
|Open for SELECT with repeatable read.||Open for read.||Both succeed.||Both succeed.|
|Open for SELECT with repeatable read.||Open for write.||The open operation on transaction 2 fails with an ERROR_SHARING_VIOLATION exception.||The open operation on transaction 2 fails with an ERROR_SHARING_VIOLATION exception.|
Write-Through from Remote Clients
Remote file system access to FILESTREAM data is enabled over the Server Message Block (SMB) protocol. If the client is remote, no write operations are cached by the client side. The write operations will always be sent to the server. The data can be cached on the server side. We recommend that applications that are running on remote clients consolidate small write operations to make fewer write operations using larger data size.
Creating memory mapped views (memory mapped I/O) by using a FILESTREAM handle is not supported. If memory mapping is used for FILESTREAM data, the Database Engine cannot guarantee consistency and durability of the data or the integrity of the database.
Enable and Configure FILESTREAM
Create a FILESTREAM-Enabled Database
Create a Table for Storing FILESTREAM Data
Access FILESTREAM Data with Transact-SQL Create Client Applications for FILESTREAM Data
Access FILESTREAM Data with OpenSqlFilestream
Make Partial Updates to FILESTREAM Data
Avoid Conflicts with Database Operations in FILESTREAM Applications
Move a FILESTREAM-Enabled Database
Set Up FILESTREAM on a Failover Cluster
Configure a Firewall for FILESTREAM Access
FILESTREAM Compatibility with Other SQL Server Features
Filestream and FileTable Dynamic Management Views (Transact-SQL)
Filestream and FileTable Catalog Views (Transact-SQL)
Filestream and FileTable System Stored Procedures (Transact-SQL)