Command Quick Reference¶

---

Loading cdapython package¶

In [1]:

from cdapython import Q, columns, unique_terms, query

from cdapython import Q, columns, unique_terms, query

cdapython version¶

In [2]:

import cdapython
print(cdapython.__version__)

import cdapython print(cdapython.__version__)

2022.6.22

columns()¶

Show all available columns in the table. By default, columns() returns Subject entity fields.

Usage: columns(<optional args>)

In [3]:

help(columns)

help(columns)

Help on function columns in module cdapython.utils.utility:

columns(version: 'Optional[str]' = 'all_Subjects_v3_0_w_RS', host: 'Optional[str]' = None, offset: 'int' = 0, limit: 'int' = 100, table: 'Optional[str]' = None, verify: 'Optional[bool]' = None, async_req: 'Optional[bool]' = None, pre_stream: 'bool' = True, files: 'Optional[bool]' = False, async_call: 'bool' = False, show_sql: 'bool' = False) -> "Optional['StringResult']"
    [summary]
    
    Args:
        version (Optional[str], optional): [description]. Defaults to table_version.
        host (Optional[str], optional): [description]. Defaults to None.
        limit (int, optional): [description]. Defaults to 100.
        table (Optional[str], optional): [description]. Defaults to None.
        verify (Optional[bool], optional): [description]. Defaults to None.
        async_req (Optional[bool], optional): [description]. Defaults to None.
        pre_stream (bool, optional): [description]. Defaults to True.
    
    Returns:
        Optional[object]: [description]

unique_terms()¶

For a given column show all unique terms.

Usage: unique_terms(<col_name>, <optional args>)

In [4]:

help(unique_terms)

help(unique_terms)

Help on function unique_terms in module cdapython.utils.utility:

unique_terms(col_name: 'str', system: 'str' = '', offset: 'int' = 0, limit: 'int' = 100, host: 'Optional[str]' = None, table: 'Optional[str]' = None, verify: 'Optional[bool]' = None, async_req: 'Optional[bool]' = None, version: 'Optional[str]' = 'all_Subjects_v3_0_w_RS', files: 'Optional[bool]' = False, show_sql: 'bool' = False) -> "Optional['StringResult']"
    [summary]
    
    Args:
        col_name (str): [description]
        system (str, optional): [description]. Defaults to "".
        limit (int, optional): [description]. Defaults to 100.
        host (Optional[str], optional): [description]. Defaults to None.
        table (Optional[str], optional): [description]. Defaults to None.
        verify (Optional[bool], optional): [description]. Defaults to None.
        async_req (Optional[bool], optional): [description]. Defaults to None.
        pre_stream (bool, optional): [description]. Defaults to True.
    
    Returns:
        Optional[List[Any]]: [description]

Q()¶

Executes this query on the public CDA server.

Usage: <result> = Q(<column> <operator> <value>)

Where:

• <result> is any user created variable
• <column> is a value from columns()
• <operator> is a valid comparison operator
• <value> is a numeric/boolean/unique value from unique_terms()

Returns: cda-python Q data type

Q().run()¶

Retrieves results of a Q() query.

Usage: <result>.run(<optional args>)

Where:

• <result> is a user created variable containing an executed Q() query

In [5]:

help(Q.run)

help(Q.run)

Help on function run in module cdapython.Q:

run(self: ~TQ, offset: int = 0, limit: int = 100, version: Optional[str] = None, host: Optional[str] = None, dry_run: bool = False, table: Optional[str] = None, async_call: bool = False, verify: Optional[bool] = None, verbose: Optional[bool] = True, filter: Optional[str] = None, flatten: Optional[bool] = False, format: str = 'json', show_sql: Optional[bool] = False) -> Union[cdapython.results.result.Result, cda_client.model.query_created_data.QueryCreatedData, multiprocessing.pool.ApplyResult]
    _summary_
    
    Args:
        offset (int, optional): _description_. Defaults to 0.
        limit (int, optional): _description_. Defaults to 100.
        version (Optional[str], optional): _description_. Defaults to None.
        host (Optional[str], optional): _description_. Defaults to None.
        dry_run (bool, optional): _description_. Defaults to False.
        table (Optional[str], optional): _description_. Defaults to None.
        async_call (bool, optional): _description_. Defaults to False.
        verify (Optional[bool], optional): _description_. Defaults to None.
        verbose (Optional[bool], optional): _description_. Defaults to True.
        filter (Optional[str], optional): _description_. Defaults to None.
        flatten (Optional[bool], optional): _description_. Defaults to False.
        format (Optional[str], optional): _description_. Defaults to "json".
    
    Returns:
        Optional[Result]: _description_

Q().count()¶

Retrieves summary counts of a Q() query.

Usage: <result>.count(<optional args>)

Where:

• <result> is a user created variable containing an executed Q() query

In [6]:

help(Q.count)

help(Q.count)

Help on property:

    _summary_
    this is a chaining method used to get counts
    Returns:
        _type_: _description_

Valid Q() comparsion operators¶

• = : Equals
• != : Not Equal
• OR
• %: a wildcard
• AND
• IS and IS NOT
• > : Greater than
• < : Less than
• >= : Greater than or Equal to
• <= : Less than or Equal to
• NOT()
• IN()
• NOT IN()

Combining Q() Queries¶

AND()¶

Combines shared results of two or more Q() queries.

Usage: <query3> = <query1>.AND(<query2>)

Where:

• <query1> and <query2> are user created variables containing different executed Q() queries

Returns: a cda-python Q data type where the result of <query3> is taken only from the results that appear in both <query1> and <query2>

In [7]:

help(Q.AND)

help(Q.AND)

Help on function AND in module cdapython.Q:

AND(self, right: 'Q') -> 'Q'

OR()¶

Combines all results of two or more Q() queries.

Usage: <query3> = <query1>.OR(<query2>)

Where:

• <query1> and <query2> are user created variables containing different executed Q() queries

Returns: a cda-python Q data type where the result of <query3> is taken from any results in either <query1> or <query2>

In [8]:

help(Q.OR)

help(Q.OR)

Help on function OR in module cdapython.Q:

OR(self, right: 'Q') -> 'Q'

NOT¶

Run a query on existing Q() query results.

Usage:

• <query4> = <query3>.FROM(query1)

OR

• <query4> = <query3>.FROM(query1.And(query2))

Where:

• <query1>, <query2>, and <query3> are user created variables containing different executed Q() queries

Returns: a cda-python Q data type where the result of <query3> is taken only from the results of <query1> OR <query1> and <query2>

---

Last update: 2022-06-22