-
Notifications
You must be signed in to change notification settings - Fork 41
Export Import File Types
joyfullservice edited this page Feb 7, 2022
·
2 revisions
Note: This page is a work in progress. Feel free to contribute!
The following outline illustrates the folder and file structure used by the add-in when exporting source files for a project. (For simplicity, ADP project folders are not shown here.)
Note that in your export folder you will only see the folders and files for the components actually used in your database. See Supported Objects for a comprehensive list of object types and the related code sections in this add-in.
.
├── ...
├── .gitattributes # (Recommended for git) Configure git attributes
├── .gitignore # (Recommended for git) Ignore specific files in git
├── Database.accdb # Main database file
└── Database.accdb.src # Folder for source file export (default path)
├── forms # Access forms
│ ├── MyForm.bas # Object definition
│ └── MyForm.json # Custom print settings (if used)
├── images # Linked images
│ ├── MyPicture.png # Image file
│ └── MyPicture.json # Image metadata
├── imexspecs # Legacy table-based import/export specifications
│ └── LinkedTableSpec.json # Json representation of specification
├── macros # Macros
│ └── AutoExec.bas # Object definition
├── modules # VBA modules (standard and class)
│ ├── MyModule.bas # Standard module
│ └── MyClass.cls # Class module
├── queries # Queries
│ ├── MyQuery.bas # Object definition
│ └── MyQuery.sql # Raw SQL definition (easier to see changes)
├── relations # Database relationships
│ └── Table1Table2.json # Json representation of a single relationship
├── reports # Reports
│ ├── MyReport.bas # Object definition
│ └── MyReport.json # Print settings
├── savedspecs # XML-based import/export specifications
│ └── MyExport.json # Metadata with embedded XML
├── tables # Table data
│ ├── MyTable.txt # Tab-delimited text format (more readable)
│ └── MyTable.xml # XML table data (better data preservation)
├── tbldefs # Table definitions (structure, columns)
│ ├── MyTable.sql # A SQL rendition of the table structure (more readable)
│ └── MyTable.xml # XML object definition (for export/import)
├── tdmacros # Table Data Macros
│ └── MyTable.xml # Object definition
├── themes # Database themes (visual appearance)
│ ├── Angles.thmx # Self-contained zip file
│ └── Executive # (Alternate) Extracted contents folder
│ ├── _rels # Recommended when customizing the theme
│ ├── theme # files in a database project
│ └── ... #
├── vbeforms # MSForms 2.0 Forms (Traditional VBA Forms)
│ ├── MyForm.frm # Form definition stub
│ ├── MyForm.frx # Binary OLE Blob content and structure
│ └── MyForm.json # Json representation of content and structure
├── Build.log # VCS build log
├── dbs-properties.json # DAO database properties
├── documents.json # Document container metadata
├── Export.log # VCS export log
├── hidden-attributes.json # Hidden flag attributes
├── nav-pane-groups.json # Custom navigation pane groups
├── project.json # File format and Remove Personal Info flag
├── proj-properties.json # CurrentProject properties
├── vbe-project.json # VBA project properties
├── vbe-references.json # VBA project references
├── vcs-index.json # Index to track changes and versions for VCS
└── vcs-options.json # VCS options for this project
These files are present in the MSAccessVCS-Addin project; they may or may not be present in your repository depending on how you have yours set up.
| File | Present When | Details & Description |
|---|---|---|
.gitattributes |
Always | Tells git and github what each file type does, and how to handle line endings, etc. See git-scm gitattributes for more information. |
.gitignore |
Always | Tells git about any specific files, file types, or folders that should be ignored (ensures you don't commit stuff that shouldn't be there). See git-scm gitignore for more information |
| Contributing.md | Always (Advised) | Front page information about how to contribute to the MSAccessVCS-Addin project! |
| License.txt | Always (Advised) | Outlines the requirements to share this code. Include in your repository if you share it. |
| README.md | Always (MSAccessVCS-Addin) | Landing page for MSAccessVCS-Addin on github. |
Version Control.accda |
MSAccessVCS-Addin | This is the versioned tool; your file will be located in here as well. |
Version Control_VCSBackup[n].accda |
MSAccessVCS-Addin | When you build from source, the existing file is backedup. The first one is simply named [Your Database]_VCSBackup.[extension]. Subsequent ones are numbered [Your Database]_VCSBackup[1,2,3,...,n].[extension] and so forth. |
The source code for the exported database is (by default) stored in the same folder as the database, with the name [YourSource.extension].src. See Options for more information on this if you want to move it elsewhere.
The below are the default folders for export/import. There may be future work to change this; see Issue 222 "Support Rubberduck @Folder annotations in modules" if you want to help with this.
Forms are exported into the forms folder by default. Each form will be exported as [FormName].bas.
| File or Type | Present When | Details & Description |
|---|---|---|
*.bas |
Form Export | Exported for each form present in the database. |
*.json |
Form Print settings | Only exported if the form has print settings (rare). Contains printer formatting and page settings. |
Images stored in MSysResources are exported into the images folder by default.
| File or Type | Present When | Details & Description |
|---|---|---|
*.[imgext] |
Image Export | Exported for each Image present in the database. Exported with file name and type. |
*.json |
Image details and attributes | Exported for each image. Contains meta data such as the image mouseover name, internal name of the file, extension, and handling class (export/import handler). |
Macros are exported into the macros folder by default.
| File or Type | Present When | Details & Description |
|---|---|---|
*.bas |
Macro Export | Exported for each macro present in the database. Contains macro source code and other build information. |
Macros are exported into the macros folder by default.
| File or Type | Present When | Details & Description |
|---|---|---|
*.bas |
Code Module Export | Exported for each module (non-class) present in the database. Contains source code and other attributes. |
*.cls |
Code Class Module Export | Exported for each class module present in the database. Contains source code and other attributes such as default member, internal VBA name, etc. |
Queries are exported into the queries folder by default.
| File or Type | Present When | Details & Description |
|---|---|---|
*.bas |
Each Query | Exported for each query present in the database. Contains source code, link data, and other attributes. If you used the query designer to create the query, it will contain that information, as well. |
SQL |
Each Query | If you were to generate a table via SQL, this would be the SQL you'd use. Because Access SQL (SQL Jet) doesn't care about formatting/display width/display height, if you use this, the query won't "look" (visually: it'll still contain the same information) the same when you open it in Access. |
Reports are exported into the reports folder by default.
| File or Type | Present When | Details & Description |
|---|---|---|
*.bas |
Reports Export | Exported for each Report present in the database. |
*.json |
Report Print settings | Only exported if the report has print settings (nearly always for reports). Contains printer formatting and page settings. |
Table data is exported into tables folder by for each table you setup to export data. See Options for what you can choose.
| File or Type | Present When | Details & Description |
|---|---|---|
*.xml |
XML Data Export | There will be one .XML file for each table setup to have the data exported as XML. |
*.TDF |
TDF Data Export | There will be one .TDF file for each table setup to have the data exported as TDF. This is more human readable, but may lose some information, especially if you have "Special Charachters". |
Table definitions are exported into the tbldefs folder by default. Note table data is not part of the table definition. Table data is stored elsewhere.
| File or Type | Present When | Details & Description |
|---|---|---|
JSON |
Linked Tables Only | Contains additional table attributes (should be all, but I'm sure there's probably an edge case that's not been caught yet), such as connection string, the Access table name, the linked table name (on the server), a list of attributes (it's a long type that's used in bitwise fashion), and a few other bits to cue MSAccessVCS how to import the table. |
XML |
Local Tables Only | Table format and extra information (such as row display height, column display width, required/not, column formatting information (Plain Text/RTF, Date Time formatting, etc.) and so on. It is the most 'reliable' and full export of the local table as it (usually) contains all the meta data about the table. XML ensures pretty much all the format and data will be the same when you rebuild. If you export the table data, too (it's stored in a separate folder), then XML is the way to go (usually). You can also export Table data via TDF (Tab Delimited Format) if you want something more human-readable. XML by its nature is not as row or character dependent. Access also isn't careful at exporting the same components in the same way every time, so the export is mildly prone to code noise during export (AKA: git will think there's changes, when there aren't). |
SQL |
Linked and Local Tables | If you were to generate a table via SQL, this would be the SQL you'd use. Because Access SQL (SQL Jet) doesn't care about formatting/display width/display height, if you use this, the table won't "look" the same when you open it in Access. |
Themes are exported into the themes folder by default. See Options for what you can choose.
| File or Type | Present When | Details & Description |
|---|---|---|
*.thmx |
Extract theme files is OFF | If you don't export the Themes, each theme in your database will be extracted separately in its own .thmx file. This is simply a .zip file with some special handling. |
\ThemeFolder |
Extract theme files is ON | If you extract theme files, each theme will be in its own subfolder; there will be .XML files inside as well for the vairious theme components. |