## handles.NeonHandle


A Neon Postgres connection URL for a branch or a pinned point in time.


Usage

``` python
handles.NeonHandle(
    key,
    read_only,
    url,
    branch="",
)
```


[url](handles.NeonHandle.md#tether.handles.NeonHandle.url) carries the role's password (it is what `tether open` hands to `psql`); it is kept out of `repr` and `redacted_url` is what anything that logs or displays the handle should use.


## Parameter Attributes


`key: str`  
A short native label for display: the store's URI, path, repository, or database - or, for a branch-addressed system such as Neon, the branch the handle opens. Not an identity: two handles on one store may carry different keys, and the engine never compares handles by it. Use the typed fields ([uri](handles.FileHandle.md#tether.handles.FileHandle.uri), [path](handles.GitHandle.md#tether.handles.GitHandle.path), [branch](handles.NeonHandle.md#tether.handles.NeonHandle.branch), [snapshot_id](handles.IcebergHandle.md#tether.handles.IcebergHandle.snapshot_id), …) for anything that matters.

`read_only: bool`  
Whether writes through this handle are allowed.

`url: str`  
`postgresql://...` connection URL (credentials per the Neon API).

`branch: str = ``""`  
Neon branch name the URL points at.