sp_helpfile (Transact-SQL)

Returns the physical names and attributes of files associated with the current database. Use this stored procedure to determine the names of files to attach to or detach from the server.

Topic link iconTransact-SQL Syntax Conventions

Syntax

sp_helpfile [ [ @filename= ] 'name' ]

Arguments

  • [ @filename = ] 'name'
    Is the logical name of any file in the current database. name is sysname, with a default of NULL. If name is not specified, the attributes of all files in the current database are returned.

Return Code Values

0 (success) or 1 (failure)

Result Sets

Column name

Data type

Description

name

sysname

Logical file name.

fileid

smallint

Numeric identifier of the file. Is not returned if name is specified.

filename

nchar(260)

Physical file name.

filegroup

sysname

Filegroup in which the file belongs.

NULL = File is a log file. This is never a part of a filegroup.

size

nvarchar(15)

File size in kilobytes.

maxsize

nvarchar(15)

Maximum size to which the file can grow. A value of UNLIMITED in this field indicates that the file grows until the disk is full.

growth

nvarchar(15)

Growth increment of the file. This indicates the amount of space added to the file every time that new space is required.

0 = File is a fixed size and will not grow.

usage

varchar(9)

For data file, the value is 'data only' and for the log file the value is 'log only'.

Permissions

Requires membership in the public role.

Examples

The following example returns information about the files in AdventureWorks2008R2.

USE AdventureWorks2008R2;
GO
EXEC sp_helpfile;
GO