execute Method

On This Page

Description

Executes the specified command. This method is used to extend the basic functionality of the other client methods. Currently, the NoSQL backend supports an infer_schema command with an infer alias for inferring the table schema.

Syntax

execute(backend, table, command=""
Note

The method has additional parameters that aren't currently supported for the NoSQL backend. Therefore, when calling the method, be sure to explicitly specify the names of all parameters after table.

Parameters and Data Members

backend | command | table

backend

The backend type — "nosql" or "kv" for the NoSQL backend. See Backend Types.

  • Type: str
  • Requirement: Required
table

The relative path to the backend data — a directory in the target data container (as configured for the client object) that represents a NoSQL table. For example, "mytable" or "examples/nosql/my_table".

  • Type: str
  • Requirement: Required
command

The command to execute.

  • Type: str
  • Requirement: Required
  • Valid Values: The NoSQL backend currently supports an "infer_schema" or "infer" command, which infers the schema of a given NoSQL table and creates a schema for the table. The command creates a .#schema file in the table directory. For more information, see Table Schema in the Frames NoSQL backend overview. All references to the infer_schema command in the documentation apply also to the infer alias.

Examples

infer_schema Examples

Following are examples of using the infer_schema command of the execute method or its infer alias:

  1. Infer the schema of a mytable table in the client's data container (table) using the infer command (command):

    client.execute(backend="nosql", table="mytable", command="infer")

  2. Infer the schema of a my_tables/students table in the client's data container (table) using infer_schema (command):

    client.execute("nosql", table="/my_tables/students", command="infer_schema")

See Also