Skip to content

Latest commit

 

History

History
74 lines (60 loc) · 3.52 KB

File metadata and controls

74 lines (60 loc) · 3.52 KB
title File Element (XMLA) | Microsoft Docs
ms.custom
ms.date 03/14/2017
ms.prod sql-server-2016
ms.reviewer
ms.suite
ms.technology
analysis-services
docset-sql-devref
ms.tgt_pltfrm
ms.topic reference
apiname
File Element
apilocation
apitype Schema
applies_to
SQL Server 2016 Preview
f1_keywords
microsoft.xml.analysis.file
urn:schemas-microsoft-com:xml-analysis#File
helpviewer_keywords
File element
ms.assetid 3dfd0e9b-746b-4ce5-8a95-610d2e573739
caps.latest.revision 12
author jeannt
ms.author jeannt
manager erikre

File Element (XMLA)

Identifies a file to be used by the parent Backup or Restore command, or by the parent Location element.

Syntax

  
<Backup> <!-- or one of the elements listed below in the Element Relationships table -->  
   ...  
   <File>...</File>  
   ...  
</Backup>  

Element Characteristics

Characteristic Description
Data type and length String
Default value None
Cardinality 1-1: Required element that occurs once and only once.

Element Relationships

Relationship Element
Parent elements Backup, Location, Restore
Child elements None

Remarks

The File element contains a UNC file name, and the parent element determines the use of the File element.

For Backup commands, the File element determines the name of the backup file created by the Backup command. If a path is not specified as part of the file name, the path specified in the BackupDir configuration property for the instance of [!INCLUDEmsCoName] [!INCLUDEssNoVersion] [!INCLUDEssASnoversion] is used. If the specified file already exists, an error occurs unless the AllowOverwrite element of the parent Backup command is set to True.

For Restore commands, the File element determines the name of the backup file to be restored by the Restore command.

For Location elements, the File element describes a remote backup file for an [!INCLUDEssASnoversion] instance that contains remote partitions. For more information about backing up and restoring remote partitions, see Backing Up, Restoring, and Synchronizing Databases (XMLA).

See Also

AllowOverwrite Element (XMLA)
Properties (XMLA)