Skip to content

Query Arguments

This section documents several sets of arguments that are not function-specific, but can be supplied to any crandas function that lists **query_args in the function signature. Command options affect the current command execution while execution options generally refer to global options. Separately, upload options only apply to upload commands, like upload_pandas_dataframe andread_parquet.

Command options

  • mode (str ("open" / "defer" / "regular"), default: "regular") - mode in which to perform queries that return objects:
    • "regular": perform computation and wait, return metadata
    • "open": perform computation and return opened result
    • "defer": initiate computation, do not wait for result
  • add_nonce (bool, default: False) - if True, add a nonce to the query so that it is guaranteed to be recomputed (instead of possibly re-using a cached result)

Execution options

All execution options are optional; if not given, the default value from the session is used (e.g., if dry_run is None, then crandas.base.session.dry_run is used).

  • dry_run (bool/None) - is it a dry run of the process
    • If None, use value from session (default: False)
    • If True, perform a dry run: do not actually perform the queries but instead return dummy values with of the type of the query result.
  • session (crandas.base.Session/None) - Session in which to execute the query. If None, use crandas.base.session.

Upload options

These arguments apply to uploads:

  • auto_bounds (bool, default: False, the default is configurable by config.settings.auto_bounds, see crandas.config) if True, do not warn about data-derived column bounds.

It is recommended to always manually supply ctypes and the bounds therein for all columns, to avoid unintentionally leaking information about the data (for example, the maximum length of a string). For ease of use, the system does allow omitting the ctypes, and deriving them and the bounds from the data. However, to make sure the user intended for this, the default behavior is to print a warning whenever a bound was automatically derived from the data. Setting this parameter (or the session or configuration variable) to True disables the warning.