Connecting to your Database!... 3

Transcription

1 Connecting to your Database!... 3 Connecting to Access Databases!... 3 Connecting to SQL Server!... 8 Connecting to Oracle! Connecting to MySQL! Connecting to Sybase! Connecting to IBM DB2! Connecting to PostgreSQL! Browsing Data! Record List Screen! Record Detail Screen! Searching Data! Quick Search! Query Builder! Query Bookmarks and History! Searching with raw SQL! Editing Data! Editing Existing Records! Creating New Records! Deleting Records! Charts!... 32

2 Exporting & Printing! Advanced Topics! Enterprise Auto-Discovery! Tunneling Connections over SSH! Help & Support!... 41

3 Connecting to your Database CONNECTING TO ACCESS DATABASES Access Connections Microsoft access databases are stand-alone files, and so the database file must be transferred to your ios device in order to open it in Access Mobile Database Client. This is in contrast to many other databases, which connect over a network in client-server mode. While having your database file on your device prevents the ability to work on the data concurrently with other users, it also allows you to work with your database in a disconnected environment, such as on an airplane. Note: Access Mobile Database Client supports databases in the Access 97, 2000, 2002, 2007, and 2010 formats. It does not support databases exported as Web Databases, nor does it support databases exported for Snapshot Viewer Note: Access Mobile Database Client does not support encrypted Access database files. In order to open an encrypted file, you must first remove the decryption in the Database Tools menu of MS Access. There are two primary ways of transferring your database from your Windows desktop to your ios device: mailing your database to yourself, and transferring the database from your desktop to your ios device using itunes File Sharing.

4 Transferring Access Database via Mail 1. On your desktop, find your.accdb or.mdb database file and add it as an attachment in an to yourself 2. On your ios device, open the Mail app and check for incoming mail. 3. In the body of the mail, tap on the attached database file, and an option for Open in Access will appear. Tap the button, and DataGlass Mobile Database Client will be launched and the database will be imported.

5 Transferring Access Database via itunes File Sharing 1. On your desktop, locate your.accdb or.mdb database file. 2. Plug your ios device into your desktop or laptop using the USB cable and open itunes. 3. In the left panel of itunes, locate and click on your ios device name. 4. At the top of the screen for the device, select the Apps tab. 5. Scroll down to the File Sharing section at the bottom of the screen. 6. Select Access from the list of apps. 7. Drag your Access database from your computer into the file list. 8. When you next launch Access Mobile Database Client, you will see your database in the list of available databases.

6 Transferring Access Database using Dropbox 1. Sign up for a free account at if you don t already have one. 2. Upload your.mdb or.accdb" file to your dropbox account using their desktop integration program. 3. Download the free Dropbox app from the Apple itunes App Store, launch it, and log in. 4. Browse to your database file and tap the forward button, then select Access as the application to open the database with. Note: When you first select your database in Dropbox, the app may say Unable to view file, but you should still be able to tap the forward button to open it in Access Mobile Database Client. Note: Modifications made to your database will not be saved back to your Dropbox account, but instead will be saved locally on your ios device. To get your modified database back to your desktop, you need to transfer it back using the itunes File Sharing method, or by tapping Edit from the database list, selecting your database, and then mailing your database back to yourself, or opening it another application (such as the official DropBox app).

7

8 CONNECTING TO SQL SERVER 1. Open the SQL Server Mobile Database Client app and from the top-level screen select Edit and tap New Connection 2. In the subsequent connection screen, enter the IP address or host name of the the database host. Consult your database administrator if you need this information. Note: if you enter a host name rather than an IP address, you need to make sure that the host name is able to be looked up by your ios device. This is frequently a problem with host names on an internal network that are only identifiable from Windows machines. If you have problems connecting, find the IP address of the host and use that instead, or else contact your system administrator for assistance. 3. Fill in a valid User Name and Password for the database. Note: by default, SQL Server Mobile Database Client uses the native SQL Server authentication. If you need to use integrated Windows authentication instead, tap the Advanced button and fill in the Windows Domain. 4. If you want to connect to a specific database name, fill it into the Database Name field. Note: this is different from a SQL Server s Instance Name, which you can enter from the Advanced button. 5. If your databases uses a non-standard port, enter it into the Database Port field. 6. Enter an optional Description if you want a specific description to show up for that connection in the databases list. 7. Enter any additional advanced connection information in the Advanced button, including timeouts, character encoding, and SSH Tunnel information.

9 8. Tap the Save button to save your connection. 9. Tap the resulting new entry in the databases list to make the connection. The first time you connect, it may take a little while to read in the schema and table information for the database. 10. Once connected, you can start browsing your data.

10 CONNECTING TO ORACLE 1. Open the Oracle Mobile Database Client app and from the top-level screen select Edit and tap New Connection 2. In the subsequent connection screen, enter the IP address or host name of the the database host. Consult your database administrator if you need this information. Note: if you enter a host name rather than an IP address, you need to make sure that the host name is able to be looked up by your ios device. This is frequently a problem with host names on an internal network that are only identifiable from Windows machines. If you have problems connecting, find the IP address of the host and use that instead, or else contact your system administrator for assistance. 3. Fill in a valid User Name and Password for the database. 4. Enter the Oracle database identifier into the Database SID field. Note: If your Oracle installation uses a Service Name rather than an SID, you can specify to use the service name by tapping the Advanced button. 5. If your databases uses a non-standard port, enter it into the Database Port field. 6. Enter an optional Description if you want a specific description to show up for that connection in the databases list. 7. Enter any additional advanced connection information in the Advanced button, including encryption settings and SSH Tunnel information. 8. Tap the Save button to save your connection. 9. Tap the resulting new entry in the databases list to make the connection. The first time you connect, it may take a little while to read in the schema and table information for the database. 10. Once connected, you can start browsing your data.

11 CONNECTING TO MYSQL 1. Open the MySQL Mobile Database Client app and from the top-level screen select Edit and tap New Connection 2. In the subsequent connection screen, enter the IP address or host name of the the database host. Consult your database administrator if you need this information. 3. Fill in a valid User Name and Password for the database. 4. If you want to connect to a specific database name, fill it into the Database Name field. 5. If your databases uses a non-standard port, enter it into the Database Port field. 6. Enter an optional Description if you want a specific description to show up for that connection in the databases list. 7. Enter any additional advanced connection information in the Advanced button, including timeouts, character encoding, and SSH Tunnel information. 8. Tap the Save button to save your connection. 9. Tap the resulting new entry in the databases list to make the connection. The first time you connect, it may take a little while to read in the schema and table information for the database. 10. Once connected, you can start browsing your data.

12 CONNECTING TO SYBASE 1. Open the Sybase Mobile Database Client app and from the top-level screen select Edit and tap New Connection 2. In the subsequent connection screen, enter the IP address or host name of the the database host. Consult your database administrator if you need this information. 3. Fill in a valid User Name and Password for the database. 4. If you want to connect to a specific database name, fill it into the Database Name field. 5. If your databases uses a non-standard port, enter it into the Database Port field. 6. Enter an optional Description if you want a specific description to show up for that connection in the databases list. 7. Enter any additional advanced connection information in the Advanced button, including timeouts, character encoding, and SSH Tunnel information. 8. Tap the Save button to save your connection. 9. Tap the resulting new entry in the databases list to make the connection. The first time you connect, it may take a little while to read in the schema and table information for the database. 10. Once connected, you can start browsing your data.

13 CONNECTING TO IBM DB2 1. Open the DB2 Mobile Database Client app and from the top-level screen select Edit and tap New Connection 2. In the subsequent connection screen, enter the IP address or host name of the the database host. Consult your database administrator if you need this information. 3. Fill in a valid User Name and Password for the database. 4. If you want to connect to a specific database name, fill it into the Database Name field. 5. If your databases uses a non-standard port, enter it into the Database Port field. 6. Enter an optional Description if you want a specific description to show up for that connection in the databases list. 7. Enter any additional advanced connection information in the Advanced button, including timeouts, character encoding, and SSH Tunnel information. 8. Tap the Save button to save your connection. 9. Tap the resulting new entry in the databases list to make the connection. The first time you connect, it may take a little while to read in the schema and table information for the database. 10. Once connected, you can start browsing your data.

14 CONNECTING TO POSTGRESQL 1. Open the PostgreSQL Mobile Database Client app and from the top-level screen select Edit and tap New Connection 2. In the subsequent connection screen, enter the IP address or host name of the the database host. Consult your database administrator if you need this information. 3. Fill in a valid User Name and Password for the database. 4. If you want to connect to a specific database name, fill it into the Database Name field. 5. If your databases uses a non-standard port, enter it into the Database Port field. 6. Enter an optional Description if you want a specific description to show up for that connection in the databases list. 7. Enter any additional advanced connection information in the Advanced button, including timeouts, character encoding, and SSH Tunnel information. 8. Tap the Save button to save your connection. 9. Tap the resulting new entry in the databases list to make the connection. The first time you connect, it may take a little while to read in the schema and table information for the database. 10. Once connected, you can start browsing your data.

15 Browsing Data RECORD LIST SCREEN After creating a connection to your database and selecting the connection, you will be taken to the schema browser, where you can browse through the schemas, tables, and views defined in your database. Tapping on any of the tables or views will take you into a screen with the complete list of contents of the table.

16 The interface for the record list consists of the following components: In the upper-left corner is a back button that will return you to the previous screen. In the upper-right corner is a search button you can use to bring up the query builder screen as well as recent searches and search bookmarks. See: Query Builder Below the top buttons is a list of the column names of the current table. Tapping on any of the column buttons will sort the currently-loaded records based on that field in ascending order. Tapping a second time will sort the records in reverse order. Below the column list is the quick search field, where you can enter a search term. See: Quick Search Below the search field is the actual list of records in the database. Tapping on any of the records will bring you into a screen with more details about the records, as well as the ability to edit or delete the record. Also, when a record list has more columns than can fit on the current screen, you can tap and hold a record and drag your finger to the left to scroll to see more columns in the table list. The circular toolbar button in the lower-left corner is the refresh button, which you can use to re-execute the most recent query. This can be useful if your database contents have changed and you want to see the new contents. The next toolbar plus button can be used to add a new record to the current table. See: Creating New Records

17 The double arrow button is used when the number of records is greater than the default maximum to show at once (the default is 100 records, although this can be changed in the settings for the app). Tapping the double down arrows will load the next batch of 100 records. The double arrow ending in a square in the toolbar will try to load all of the query results. Note that this could result in memory and performance slowdowns if your table contains millions of rows, since those rows all need to be transferred the the app. The line chart toolbar button can be tapped to bring up the chart builder. The toolbar button in the lower-right corner can be used to export, mail, or print the current list of records.

18 RECORD DETAIL SCREEN When you tap on any record in the Record List Screen, you will be taken to the Record Detail Screen, which contains more information about the record, as well as the ability to edit, delete, and drill into relationships. The interface for the record list consists of the following components:

19 In the upper-left corner is the back button that will take you to the previous record list screen. In the upper-right corner is the Edit button that will allow you to make changes to the record, provided you have sufficient permissions and the record contains database primary keys to uniquely identify it. See: Editing Existing Records. In the center of the screen are the individual fields and relationships that make up the record. Tapping on any of the fields with the chevron mark to the right will drill into the relationship or open a viewer for attached photos or text. The left-facing arrow on the bottom left will move to the previous record in the current record list. The plus button in the bottom toolbar will allow you to create a new record or duplicate the current record. See: Creating New Records. The numbers in the center of the bottom of the toolbar indicate which record from the parent record list you are currently viewing. The trash icon in the bottom toolbar offers you the ability to delete the record. See: Deleting Records. The right-facing arrow in the bottom right will move to the next record for the current record list.

20 Searching Data QUICK SEARCH The quick search bar at the top of any record list allows simple searching in the current table against a single field. You can access the search bar by going to any record list screen and sliding your finger downwards on the screen until the search bar appears. The column that you search against is controlled by which column you have selected in the column header list at the top of the screen. Note: searching in most database is case-sensitive, so searching for apple will not find records with the name Apple.

21

22 QUERY BUILDER The query builder is accessible by tapping the search icon in the upper-right corner of any schema list, table list, or record list. It provides the ability to create sophisticated queries across multiple tables and with multiple criteria and sorting options. Note: In addition to being able to specify your search columns and join criteria, you can also enter completely custom SQL in the editor at the bottom of the search screen.

23 QUERY BOOKMARKS AND HISTORY Your recent searches are visible by tapping the Recents tab in the search screen. In addition, you can create and arrange bookmarks for your favorite queries so you can re-execute them easily in the future.

24 SEARCHING WITH RAW SQL You can enter any freeform SQL that your database can handle by opening the Query Builder and selecting Custom SQL Query at the bottom of the screen. Queries entered this way will be added to your search history and can be bookmarked like any other query. Note: Since entering long text on an ios device can be tedious, you might want to consider composing the SQL query on a desktop computer and then ing it to yourself, then copying & pasting the query from your into the custom SQL query text field.

25

26 Editing Data EDITING EXISTING RECORDS Tapping on a record from the table list or search results will bring you into the record details screen, where you can view more details about the record. When the record is editable, an Edit button will be available in the upper-right corner of the screen. Tapping the edit button will allow you to tap on a field and change its contents, and then tapping Save will save the results back to the database.

27 Note: in order to be able to edit records, the table must have a primary key defined which is used to uniquely identify the record. If you are unable to edit a record, the reason is probably because the record does not have any primary key defined.

28 CREATING NEW RECORDS Tapping on the plus button in the toolbar of the record list will create a new blank record whose fields you can fill in and save. Note: in order to be able to save new records, the table must have a primary key defined which is used to uniquely identify the record. If you are unable to save a new record, the reason is

29 probably because the record does not have any primary key defined.

30 DELETING RECORDS In the record details screen, tapping the trash icon will allow you to delete the record from the database. Note: Deleting a record from the database is permanent and cannot be undone.

31 Note: in order to be able to delete records, the table must have a primary key defined which is used to uniquely identify the record. If you are unable to delete a record, the reason is probably because the record does not have any primary key defined or due to a lack of permissions in the database.

32 Charts The chart builder is available from any record list or search results list, and enables you to build simple charts from records that contain numeric data. Once you have specified the X Axis and Y Axis fields, you can tap Chart to see the screen with the chart. You can get information about the different data points by tapping and holding the screen. You can also print, mail, or export your charts with the button in the upper-right corner of the toolbar.

33

34 Exporting & Printing The export button in an record list or search result screen allows you to Save the current results as a CSV file to your ios device, from where it can be transferred to the desktop by connecting your device to itunes and going into the File Sharing section of the Apps tab for the device. You can also mail the record list, or open it in another application that can handle CSV files, such as Apple s Numbers app.

35 Advanced Topics ENTERPRISE AUTO-DISCOVERY DataGlass is able to automatically discover instances of database servers on the local network and show their information as a connection template in the "New Connection" screen. For Sybase ASE and Microsoft SQL Server, this discovery uses their built-in network advertising features and is automatic. Other databases, however, do not provide any network auto-discovery mechanism, which means that user has know and enter the correct hostname (as well as username and password). This can be tedious and error-prone, especially on the software keyboard of a small ios device. Fortunately, DataGlass is also able to query network "zeroconf" (known in Apple parlance as "Bonjour") services for information about databases, which it will use to populate the "New Connection" list. DataGlass will check for the local "_dataglass-databasename._tcp." name for this information. For example, using the "dns-sd" program (included by default on OS X, but requiring you to install Bonjour on Windows from you can register a local PostgreSQL server using the following command line in Terminal.app (Mac) or cmd.exe (Windows): dns-sd -R "My PostgreSQL Server" _dataglass-postgresql._tcp. local 5432 Host= Name=dellstore2 The anatomy of the command is as follows: My PostgreSQL Server : the title you want to appear next to the database. This will be pre-filled as the database's description _dataglass-postgresql._tcp.: the service name of the database that DataGlass will search for from the ios device 5432: the port number the database is running on. This is optional if your database is running on the default port.

36 Host= : the host name or IP address the database server is running on. If omitted, the host where the mdns service advertisement is running from will be assumed to be the database host. Name=dellstore2: the name to pre-fill into the database name of the connection. Some databases (like PostgreSQL) require this. For Oracle, this will be the database's SID. Username=xxx: the name to pre-fill into the username for the database. This is useful if many people will be sharing the same username (e.g., for report designers). The equivalent command when using the "avahi" Zeroconf implementation: avahi-publish-service -s "My PostgreSQL Server 2" _dataglass-postgresql._tcp Host= Name=dellstore2

37

38 TUNNELING CONNECTIONS OVER SSH Many networked databases prohibit direct access over the internet for security or policy reasons. This prohibition is often implemented using a firewall that blocks direct access to the network port of the database. If your organization uses a VPN that is compatible with ios built-in VPN client, you can often use that to transparently connect to your organization s internal network, and then use the app to connect directly to the database. However, many smaller organizations do not provide a VPN solution, and instead allow encrypted access using the popular SSH service. If you have been provided with SSH access to your network, you can configure to app to connect over the SSH connection in the Advanced settings for your connection s configuration.

39

40

41 Help & Support For further help and product support, please visit the community support forums at