Skip to main content

pc.list_connections

pc.list_connections(name=None, limit=inf, df=False)

     Get a list of connections available in your Predibase environment. Only displays
     what the user has access to.

Parameters:​

       name: str, default None
       Name of connection to search on.

       limit: int, default inf
       Max number of connections to return.

       df: boolean, default False
       Whether to return a pandas dataframe or a list of objects.

Returns:​

       pd.DataFrame

      OR

       List[Connection]

Examples:​

List all connections currently available to us.

    pc.list_connections()
#    >  [Connection,
#             name: Postgres Connection,
#             id: 0,
#             connection_type: ConnectionType.POSTGRESQL,
#             properties: None,
#        Connection,
#             name: S3 Connection,
#             id: 1,
#             connection_type: ConnectionType.S3,
#             properties: None]