Getting Started

To learn the basics of Groovy take a look at their documents and tutorials on their website.

Basic knowledge of the Java programming language and types is required in order to effectively design and develop scripts using the AdminShell. To learn Java language find learning resources at

You can learn about the Teiid AdminAPI either using "adminHelp()" function or by using the JavaDocs.

AdminShell is a specialized version of Groovy which works in several different modes: interactive shell, graphical console, or script run mode. In interactive shell mode (launched via adminshell), the user can invoke connect to a live Teiid system and issue any ad-hoc commands to control the system. The interactive buffer can be used to develop a script and the interactive session input and output can be captured into a log file, more on this later in the document.

In graphical mode (lanched via adminshell-console), the user can develop and run scripts using a text editor that supports syntax highlighting.

In the script run mode, the user can execute/play back previously developed scripts. This mode especially useful to automate any testing or to perform any repeated configurations/migrations changes to a Teiid system.

Essential Rules

To use AdminShell successfully, there are some basic syntactical rules to keep in mind.

  1. In interactive shell mode, most commands (as seen by the help command) are used to control shell behavior and are not general Groovy scripting constructs. Admin methods will typically be called using functional notation:

  1. All commands and functions are case sensitive.

  2. An ending semicolon is optional for Groovy statements.

  3. If a function requires input parameter(s), they should be declared inside "(" and ")". A function may have more than one parameter. String parameters can be wrapped in double or single quotes. Example:

connectAsAdmin("localhost", "9990", "user", "password", "conn1")
  1. Local admin connection may not require a password. Remote connections will typically be over the 9993 https port instead. Other Java methods and classes can be used from your scripts, if the required Java class libraries are already in class path. You may place additional jars in the lib directory to have be automatically part of the class path. An example showing an import:

import my.package.*;
myObject = new MyClass();

To execute the commands and arbitrary script in interactive mode you enter them first and press enter to execute, then enter the next line, so on.

To exit the tool in the interactive mode, first disconnect if you are connected to the Teiid system by executing "disconnect();" then type "exit". In the script mode, when execution of the script finishes the tool will exit automatically, however you still have to disconnect from Teiid system in the script.

If SSL is turned on the Teiid server, you would need to adjust the connection URL and the client SSL settings as necessary (typically this will only be needed for 2-way SSL).


The adminHelp() methods lists all the available administrative API methods in the AdminShell. Please note that none of the Groovy Shell commands or other available function calls will be shown in this list


To get a specific definition about a method and it’s required input parameters, use adminHelp("method")


 *Deploy a VDB from file
void deploy(
    String /* file name */)
  throws AdminException
  throws FileNotFoundException

The sqlHelp() methods lists all Sql extension methods.


To get a specific definition about a method and it’s required input parameters, use sqlHelp("method")

Basic Commands

The list below contains some common commands used in AdminShell.

Basic Commands
println "xxx";   // print something to console

adminHelp();     // shows all the available admin commands;

sql = connect(); // get an extended Groovy Sql connection using file

sql.execute(<SQL>); // run any SQL command.

connectAsAdmin(); // connect as admin; no need have the vdb name. SQL commands will not work under this connection

println getConnectionName();  // returns the current connection name

useConnection(<connection name>); // switches to using the given connection settings

disconnect();   // disconnects the current connection in the context

Some examples

Example of Deploying a VDB

// check to validate the deployment
VDB vdb = getVDB("<name>", 1);
if (vdb != null){
     print (vdb.getName()+"."+vdb.getVersion()+" is deployed";
else {
     print ("<name>.vdb failed to deploy";
Create a Datasource(oracle)

// first deploy the JDBC jar file for Oracle

props = new Properties();
props.setProperty("user-name", "scott");
props.setProperty("password", "tiger");

createDataSource("oracleDS", "ojdbc6.jar", props);
Create a Resource Adapter(file) based Data source

props = new Properties();
props.setProperty("ParentDirectory", "${jboss.server.base.dir}/myData");
props.setProperty("AllowParentPaths", "true");

// NOTE:  the 2nd argument, template-name, must match the 'id' of one of the resource-adapters that are currently defined in the server
createDataSource("MyFile", "file", props);
Execute SQL Query against Teiid
sql = connect("jdbc:teiid:<vdb>@mm://<host>:31000", "user", "user");

// select
sql.eachRow("select * from sys.tables") { println "${it}" }

// update, insert, delete
sql.execute(<sql command>);
Learn more about Groovy SQL

results matching ""

    No results matching ""