Share via

3.1.4.3.2.1.1.29 ImageLoad

  • Article

The ImageLoad command<375> loads a tabular database from a database folder.

The following is the XSD sample.

   <xsd:complexType name="ImageLoad">
     <xsd:all>
      <xsd:element ref="eng200_200:ImagePath" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="eng200_200:ImageUrl" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="eng200_200:ImageUniqueID" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="eng200_200:ImageVersion" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="eng100:ReadWriteMode" minOccurs="1" maxOccurs="1" >
        <xsd:simpleType>
          <xsd:restriction base="xsd:string" >
            <xsd:enumeration value="ReadWrite" />
            <xsd:enumeration value="ReadOnlyExclusive" />
          </xsd:restriction>
        </xsd:simpleType>
      </xsd:element>
      <xsd:element ref="eng100_100:DbStorageLocation" minOccurs="0" />
      <xsd:element name="DatabaseName" type="xsd:string" minOccurs="1" maxOccurs="1" />
      <xsd:element name="DatabaseID" type="xsd:string" minOccurs="1" maxOccurs="1" />
      <xsd:element name="Data" minOccurs="0">
       <xsd:complexType>
           <xsd:element name="DataBlock" type="xsd:string" minOccurs="0" 
                        maxOccurs="unbounded"/>
       </xsd:complexType>
      </xsd:element>
     </xsd:all>
   </xsd:complexType>

Element

Default value

Description

ImagePath

Empty if Data/DataBlock is specified

The UNC path of the file from which the database is to be loaded. This is a required property if the data block is not specified.

ImageUrl

Empty

The URL of the file from which this database is to be loaded.

ImageUniqueID

Empty

The unique ID of the file from which the database is to be loaded. This element is empty if the database is not loaded from a URL location.

ImageVersion

Empty

A string that represents the time stamp of the file from which the database is to be loaded. The string format is MM/dd/yyyy HH:mm:ss [AM/PM]. This element is empty if the database is not loaded from a file.

ReadWriteMode

Empty

An enumeration value that specifies the read/write mode for the database that is to be loaded.

The possible values are as follows:

  • ReadWrite – Read-write access is allowed.

  • ReadOnlyExclusive – Read-only exclusive access is allowed.

DbStorageLocation

Empty

A valid UNC path for where the server stores the data for this database.

DatabaseName

[Required]

The name of the restored database.

DatabaseID

[Required]

The ID of the restored database.

Data/DataBlock

Empty if ImagePath is specified

The binary contents of a database backup. The data block can include multiple blocks of varying sizes. This is a required property if the ImagePath property is not specified.

The return result type for the ImageLoad command is xmla-e:emptyresult.