|
| | __init__ (self, args=None, **kwargs) |
| |
| | emit (self, topic, msg, stamp=None, match=None, index=None) |
| |
| | size (self) |
| |
| | validate (self) |
| |
| | close (self) |
| |
| | close_output (self) |
| |
| | __enter__ (self) |
| |
| | __exit__ (self, exc_type, exc_value, traceback) |
| |
| | autodetect (cls, target) |
| |
| | bind (self, source) |
| |
| | configure (self, args=None, **kwargs) |
| |
| | emit_meta (self) |
| |
| | flush (self) |
| |
| | is_highlighting (self) |
| |
| | thread_excepthook (self, text, exc) |
| |
| | close_output (self) |
| |
| | ensure_rollover (self, topic, msg, stamp) |
| |
| | format_output_meta (self) |
| |
| | get_write_options (cls, label) |
| |
| | make_filename (self) |
| |
|
| | DEFAULT_ARGS = dict(META=False, WRITE_OPTIONS={}, VERBOSE=False) |
| | Constructor argument defaults.
|
| |
| str | ENGINE = "SQLite" |
| | Database engine name.
|
| |
| tuple | FILE_EXTENSIONS = (".sqlite", ".sqlite3") |
| | Auto-detection file extensions.
|
| |
| int | MAX_INT = 2**63 - 1 |
| | Maximum integer size supported in SQLite, higher values inserted as string.
|
| |
| int | COMMIT_INTERVAL = 1000 |
| | Number of emits between commits; 0 is autocommit.
|
| |
| | DEFAULT_ARGS = dict(META=False, WRITE_OPTIONS={}, VERBOSE=False) |
| | Constructor argument defaults.
|
| |
| | ENGINE = None |
| | Database engine name, overridden in subclasses.
|
| |
| list | MESSAGE_TYPE_BASECOLS |
| | Default columns for pkg/MsgType tables.
|
| |
| list | MESSAGE_TYPE_NESTCOLS |
| | Additional default columns for pkg/MsgType tables with nesting output.
|
| |
| list | MESSAGE_TYPE_TOPICCOLS |
| | Default topic-related columns for pkg/MsgType tables.
|
| |
| | DEFAULT_ARGS = dict(META=False) |
| | Constructor argument defaults.
|
| |
| tuple | FILE_EXTENSIONS = () |
| | Auto-detection file extensions for subclasses, as (".ext", )
|
| |
| | DEFAULT_ARGS = dict(WRITE_OPTIONS={}) |
| | Constructor argument defaults.
|
| |
| str | DEFAULT_DIALECT = "sqlite" |
| | Default SQL dialect used if dialect not specified.
|
| |
| dict | DIALECTS |
| | Supported SQL dialects and options.
|
| |
| list | KEYWORDS |
| | Words that need quoting if in name context, like table name.
|
| |
| | DEFAULT_ARGS = dict(WRITE=None, WRITE_OPTIONS={}, VERBOSE=False) |
| | Constructor argument defaults.
|
| |
| str | FILE_META_TEMPLATE = "{name} ({size})" |
| |
| str | MULTI_META_TEMPLATE = "\n- {name} ({size}, {mcount}, {tcount})" |
| |
| list | OPTIONS_TEMPLATES |
| | Command-line help templates for rollover options, as [(name, text with s label placeholder)].
|
| |
| str | START_META_TEMPLATE = "{mcount} in {tcount} to " |
| |
Writes messages to an SQLite database.
Output will have:
- table "messages", with all messages as serialized binary data
- table "types", with message definitions
- table "topics", with topic information
plus:
- table "pkg/MsgType" for each message type, with detailed fields,
and JSON fields for arrays of nested subtypes,
with foreign keys if nesting else subtype values as JSON dictionaries;
plus underscore-prefixed fields for metadata, like `_topic` as the topic name.
If launched with nesting-option, tables will also be created for each
nested message type.
- view "/topic/full/name" for each topic,
selecting from the message type table
Definition at line 29 of file sqlite.py.
| __init__ |
( |
|
self, |
|
|
|
args = None, |
|
|
** |
kwargs |
|
) |
| |
@param args arguments as namespace or dictionary, case-insensitive;
or a single path as the name of SQLitefile to write
@param args.write name of SQLite file to write, will be appended to if exists
@param args.write_options ```
{"commit-interval": transaction size (0 is autocommit),
"message-yaml": populate messages.yaml (default true),
"nesting": "array" to recursively insert arrays
of nested types, or "all" for any nesting),
"overwrite": whether to overwrite existing file
(default false),
"rollover-size": bytes limit for individual output files,
"rollover-count": message limit for individual output files,
"rollover-duration": time span limit for individual output files,
as ROS duration or convertible seconds,
"rollover-template": output filename template, supporting
strftime format codes like "%H-%M-%S"
and "%(index)s" as output file index}
```
@param args.meta whether to emit metainfo
@param args.verbose whether to emit debug information
@param kwargs any and all arguments as keyword overrides, case-insensitive
Reimplemented from BaseDataSink.
Definition at line 65 of file sqlite.py.
Public Member Functions inherited from BaseDataSink