DBA xPress Schema Surf

Overview

Icon	Description
	Schema Surf allows you to visualize the schema of your databases by tracking the dependencies between objects even if those dependencies are run-time dependencies. Feature Highlights View how objects in a database are related Generate entity views of objects

Use Cases

Consider the following example: 

You want to modify a table, and you need to see which objects rely on that table including any references by foreign keys, views, stored procedures, functions, and even triggers on other tables. With Schema Surf, you can create a new surf in the database that you want to surf, then select the object you're interested in to display a graph of the connected objects. Select any object in the graph and surf the inter-dependencies within your schema.

Creating a New Surf

Create a new surf by completing the following steps:

1. Select Schema Surf to open the Connect To Database window.

2. Select a database for your connection. Enter a SQL Server connection or select a previous connection from the drop down list. Enter your connection credentials, then select a database for the comparison. Select Next to load your Schema Surf.

Select SQL Server

Select Database

Navigating Schema Surf

After successfully making a connection (and creating a surf), Schema Surf loads into a blank graph. 

Select + to expand an object category in the Task pane. 

Expand category

Category expanded

Select an object in the Task pane to display a graph of any connected objects.

Hover over an object in the graph to display a tooltip that lists the number of inbound and outbound references for the object.

Select an object in the graph to change the focus of the graph to the selected object and its dependencies.

Select object in graph

Graph focused on selected object

Schema Surf Context Menu Options

Schema Surf allows you to customize the appearance of your graph with a variety of options. The following context menu options are available in Schema Surf:

Coloring your Graph

Schema Surf provides you with multiple customization options to help you navigate your server. Right click a node and select Color node to change the color of the node. 

Selecting a Color Node & dependent option and hovering over a color displays a preview of all of the affected nodes in the color. 

Removing Nodes

Right click a node to open the context menu. Select Remove node to remove an individual node. 

Select Remove Node

Node removed

Remove a node and all its dependent nodes by selecting one of the Remove Node & Dependents options. 

Select Remove Node & All Referenced Dependents

Nodes removed

Schema Surf Toolbar Options

File Options

Toolbar button	Description	Image
	Opens the Connect to Database window and allows you to create a new Schema Surf.
	Open a previously saved surf. Select a surf (.ssd) file, and then select open to load the surf.
	Save the current surf as a (.ssd) file. Enter an appropriate surf name, and then select Save to save your surf.
	Save the current surf as a (.ssd) file. Enter an appropriate surf name, and then select Save to save your surf.
	Save the current graph in your Data Surf as one of the following image files (.bmp, .jpg, .png). Select Save Surf Image to open the Export image window. Select an image Width, Height, and format, and then select Ok to open the Save Image window. Enter an appropriate name for your image, and then select Save to save the image.

Navigation Options

Button	Description	Image
	Goes back to the previously selected node in the Schema Surf. Note:  You can also go back by selecting CTRL + Left.
	Goes to the next selected node in the Schema Surf. Note:  You can also go forward by selecting CTRL + Right.
	Opens the Choose Filter window and allows you to add a filter to your Schema Surf. For a detailed description of using filters in DBA xPress, see the Object Browser Filter Tree  section. Note:  The Filter button displays in gold when a filter is active.

View Toolbar Options

View Options

Button	Description
	Zooms in on the selected graph area.
	Zooms out of the selected graph area.
	Organizes the Data Surf graph in one of the following layouts: Force Directed Circle Grid Spiral Horizontal Hierarchy Vertical Hierarchy See the Layout Algorithms table below for a depiction of each view.

Dependency Levels Options

Button	Description
	Displays more dependency routes for the selected object. Note:  You can display a maximum of ten dependency routes.
	Displays less dependency routes for the selected object.
	Displays the direct dependency route when selected. Note:  This option is active by default.

Dependency Categories Options

Button	Description
	When selected, displays dependencies between objects based on T-SQL references.
	When selected, displays dependencies between objects based on foreign keys.
	When selected, displays dependencies between objects based on schema references.
	When selected, displays dependencies between objects based on XML references.

Layout Alogorithms

Schema Surf arranges the nodes in the surf graph based on the currently selected layout algorithm. Change the layout of your graph by selecting the view tab, and then selecting the Layout button. 

There are six available algorithms to use in Schema Surf:

Layout	Description
Force Directed
Circle
Grid
Spiral
Horizontal Hierarchy
Vertical Hierarchy