Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Synapse Tables are Synapse tables are used to organize web-accessible, sharable, and queryable data. Tables may be queried and edited with the Synapse web client, as well as with the Synapse programmatic clients. This article guides you through the process of creating a Tabletable in Synapse. For information about searching a Tabletable, see Search Tables tables and Viewsviews.

To learn more about creating Tables tables and creating queries using one of the Synapse programmatic clients, see:

...

A schema is the structure of your dataset. In a Tabletable, a schema defines the structure by specifying the column names. A schema may also define the values or types of data allowed in each column.

You can define Table table columns to contain common data types like text, numbers, and dates, or you can define columns to include references to other Synapse objects, like Files like files and Foldersfolders. Synapse currently supports several kinds of text columns (STRING, LARGE TEXT), dates (as TIMESTAMP), a variety of numeric columns (INTEGER, DOUBLE), and various Synapse identifiers (ENTITYID, USER). For a complete list of column types and definitions, please see the REST docs on columnTypes.

Creating a

...

new table from a

...

file

Tables require structured data contained in a .csv or .tsv file. If your structured data is saved in an Excel format such as .xls or .xlsx, you must “save-as” to convert the file to a .csv before you proceed in Synapse. Navigate to the Tables tab in your Project project and select Upload a Table. If you provide a .csv or .tsv file, Synapse will infer your Table table schema based on the column headers. You may further customize the schema by selecting Schema Options.

For very large files, it may take time for the Table table to be built and indexed completely before it can be viewed. You may navigate away from the Table table once you have clicked Create, and you will not lose any data.

Create an

...

empty table

You have the option to create an empty Table table by clicking on the Tables Tools menu and Add Table. To build a new Tabletable, you must specify the Table table structure, column by column. Select Add Column to set the Column Name, Column Type, Size, Default Value, and Restrict Values.

If you create an empty Tabletable, you will need to click on Table Tools and Upload Data to Table to upload data from a .csv or .tsv file. The first line of your file must match the Table table structure specified.

Alternatively, you may add rows and Table table data manually. To add, delete, or modify existing rows, click on the Edit Query Results icon to Edit Rowsedit rows.

...

Click the + sign to add rows. To delete rows, check the boxes of the rows to delete and click the Trash Can icon.

Note

Warning: Column names must be 256 characters or less. There are three reserved words that cannot be used: ROW_ID, ROW_VERSION, ROW_ETAG (case insensitive).

Modify

...

table schema

Click Select Table ToolsShow Table Schema and , and then Edit Schema to modify the existing Table table structure. From Edit Schema, you can delete columns, add new columns, modify existing columns, define default column values, restrict column values, and add facet values.

Search a

...

table

You can search for data within a Table table in two ways. The default search is a simple search menu to the left of your Tabletable. Use the facets to filter your dataset and narrow down your search. Table data can also be retrieved by using a SQL-like query language either through the web portal or through the analytical clients. See the Search Tables tables and Viewsviews page for more information.

Delete a

...

table

To delete the entire Tabletable, click on the Tools menu and then select Delete Table.

Add

...

files to a

...

table

In addition to structured data, you can also add individual files to a table in Synapse. In the example below, this feature is used to add image files to a Table table containing histology data.

First, navigate to a Table table and add a new column for Filesfiles. To add columns, Click click Table ToolsShow Table Schema and , and then Edit Schema. From the pop-up window, click the Add Column button and set the Column Type as File. Click Save to exit from the Edit Columns window.

Next, click the Edit Query Results button (the pencil icon). In the column you just created, click the upload icon to add a File file from your local computer.

...

Versioning a

...

table

You can create a version history for any Table table in Synapse. Versioning helps you keep a record of what changes you made to the Table table and when you made them. For more information on versioning a Tabletable, see the Versioning Tables tables and Viewsviews page.

See Also

Annotations and QueriesqueriesDownloading DatadataFiles Versioning tables and Versioningviews

Include Page
DOCS:Article Footer - Need More Help
DOCS:Article Footer - Need More Help