Skip to content

Using the DbIo Manager

Jump to bottom
lat9 edited this page Apr 22, 2025 · 1 revision

This section describes how to use the Tools :: Database I/O Manager tool.

DbIo pre-defines the folder /YOUR_ADMIN/dbio as the location in which your comma-separated-value (CSV) files reside. Whenever DbIo outputs (exports) a datafile, the file is created in this folder; any .csv files associated with the currently-active handler found in this folder are displayed within the DbIo's "Import/File-Action Area".

When you enable DbIo's debug, using Configuration :: DbIo Manager Settings :: Enable Debug?, the log files are created within the folder /YOUR_ADMIN/dbio/logs.

Display Organization

The Database I/O Manager organizes its display into five (5) sections: image

  1. Selection Area: The topmost portion of the display contains a drop-down selection where you choose the handler to be used for the current set of actions. That handler, once selected, is saved in the current admin's session, so that the DbIo Manager remembers your most recent selection for the duration of the admin-login.
  2. Export Area: The upper-left portion of the display identifies the features available for the current handler's export. Some of the handlers (like Orders) provide additional filters to limit their output selections and support customization of the fields exported.
  3. File-Upload Area: The upper-right portion of the display provides a form that you'll use when you want to upload a .csv file from your computer for the DbIo to handle. That file, once successfully uploaded, is stored in the /YOUR_ADMIN/dbio folder.
  4. Import/File-Action Area: The bottom-left portion of the display displays the list of .csv and .log files available for the selected handler. Within this section, you can choose a file to import, split, download or delete; see the *Other File Actions* tab for additional details.
  5. Configuration Area: The bottom-right portion of the display shows you the DbIo Manager Settings that you've currently got configured as well as some pertinent system-related settings.

Export Area

This section displays the export options available for the currently-selected handler. Some of the handlers, like Orders shown below, make use of additional filters that enable you to limit the export's output and/or enable export-template customizations.

Filters, if supported by the selected handler, aren't displayed initially, since the generation of those filters can have a negative impact on the tools's performance for stores with large databases. When you tick the "show/hide filters" box, that enables/disables the automatic rendering of the filters for all handlers (the selection is stored in the currently-logged-in admin's session variables).

Templates, if supported by the selected handler, enable you to export a subset of the handler's fields. Refer to the Manage DbIo Templates tab for additional information. When a handler supports templates, like Orders, you can use a previously-customized template or click the "Manage Templates" button to create a new one.

Make your choices from the options provided by the current handler and click the Export button; the exported .csv file will be created in the /YOUR_ADMIN/dbio folder. Starting with v1.6.0, if you tick the checkbox next to the Export button, the generated .csv file will be immediately downloaded upon export; that setting is "remembered" in the currently-logged-in admin's session.

Note: Additional processing time will be required for the DbIo Manager export if you have the plugin's debug-mode enabled.

File Upload Area

f the currently-selected handler supports imports, you can use this section to upload any .csv files that you plan on importing into your site's database. Use the "Browse" button to select your file, making sure that the file is not larger than the Maximum File Upload Size shown in the DbIo configuration area, and then click the "Upload" button. The file will be saved in the /YOUR_ADMIN/dbio folder.

Note: The imported file's name must be associated with the currently-selected handler, e.g. if the Products handler is selected, the uploaded file's name must be of the form dbio.Products.*.csv.

upload_area

Import/File-Action Area

import_area

You can also use the dropdown selection at the top of the display to perform additional actions on the file selected via radio-button in the Choose File column:

  1. Split. Causes the associated .csv file to be split into multiple (and, thus, smaller) files to enable their download. Refer to the Split Record Count displayed in the configuration area and change that if needed; the value identifies the number of records (i.e. lines in the .csv) that will be associated with each "split".
  2. Import (Full). Results in the associated .csv file to be imported into your site's database. Make sure that you've created a database backup, just in case something goes awry! Note also that a full import should never, ever be run with the DbIo's debug enabled; that will severely reduce the amount of processing that can be performed!
  3. Import (Check-Only). Results in the associated .csv file to be processed like it's going to be imported, but no database changes are performed. You'll use this action, for example, to check your import file for any errors (like invalid dates) before actually updating the database. This action, too, is severely hindered by the DbIo's debug-mode.
  4. Download. Results in the associated .csv or .log file being downloaded from your site to your computer.

You can sort the files discovered by the DbIo Manager by the file-name, file-size or the last-modified date using the arrow-links in the file-list header.

Configuration Area

This section simply displays the DbIo's current configuration settings (and some of the applicable system settings) so you're aware of how the DbIo Manager is going to process your request. Clicking on the link takes you to the Configuration :: Database I/O Manager Settings page.

config_area

Clone this wiki locally