Information

The experimental module is where new features will be first tested before being added to the regular module. Check out mixins to see method documentation. Check out protos to inspect input and output proto objects for the mixin methods.

Current experimental features:

• All: Replaced google protobuf-generated code with betterproto-generated code

• PFS: mount()/unmount()- Mounting/unmounting Pachyderm repos locally

Note: The experimental module WILL NOT follow semver. Breaking changes can be introduced in the next minor version of python_pachyderm.

Experimental Mixins

• Important
• Admin mixin
• Auth mixin
• Debug mixin
• Enterprise mixin
• Health mixin
• Identity mixin
• License mixin
• PFS mixin
• PPS mixin
• Transaction mixin
• Version mixin

Experimental Protos

• Important
• Admin proto
• Auth proto
• Debug proto
• Enterprise proto
• Identity proto
• License proto
• PFS proto
• PPS proto
• Transaction proto
• Version proto

Experimental Client

class Client(host=None, port=None, auth_token=None, root_certs=None, transaction_id=None, tls=None, use_default_host=True)

Bases: python_pachyderm.experimental.mixin.admin.AdminMixin, python_pachyderm.experimental.mixin.auth.AuthMixin, python_pachyderm.experimental.mixin.debug.DebugMixin, python_pachyderm.experimental.mixin.enterprise.EnterpriseMixin, python_pachyderm.experimental.mixin.health.HealthMixin, python_pachyderm.experimental.mixin.identity.IdentityMixin, python_pachyderm.experimental.mixin.license.LicenseMixin, python_pachyderm.experimental.mixin.pfs.PFSMixin, python_pachyderm.experimental.mixin.pps.PPSMixin, python_pachyderm.experimental.mixin.transaction.TransactionMixin, python_pachyderm.experimental.mixin.version.VersionMixin, python_pachyderm.client.Client

An experimental Client. New python_pachyderm features are available here first. Refer to the Introduction section in the Experimental Mixins doc page to see the existing experimental prototypes Initialize an instance with python_pachyderm.experimental.Client().

Attributes

auth_token

transaction_id

Methods

activate_auth([root_token])	Activates auth on the cluster.
activate_enterprise(license_server, id, secret)	Activates enterprise by registering with a license server.
activate_license(activation_code[, expires])	Activates the license service.
add_cluster(id, address[, secret, ...])	Register a cluster with the license service.
authenticate_id_token(id_token)	Authenticates a user to the Pachyderm cluster using an ID token issued by the OIDC provider.
authenticate_oidc(oidc_state)	Authenticates a user to the Pachyderm cluster via OIDC.
authorize(resource[, permissions])	Tests a list of permissions that the user might have on a resource.
batch_transaction(requests)	Executes a batch transaction.
binary([filter])	Gets the pachd binary.
commit(repo_name, branch[, parent, description])	A context manager for running operations within a commit.
copy_file(source_commit, source_path, ...[, ...])	Efficiently copies files already in PFS.
create_branch(repo_name, branch_name[, ...])	Creates a new branch.
create_idp_connector(connector)	Create an IDP connector in the identity server.
create_oidc_client(client)	Create an OIDC client in the identity server.
create_pipeline(pipeline_name, transform[, ...])	Creates a pipeline.
create_pipeline_from_request(req)	Creates a pipeline from a CreatePipelineRequest object.
create_repo(repo_name[, description, update])	Creates a new repo object in PFS with the given name.
create_secret(secret_name, data[, labels, ...])	Creates a new secret.
deactivate_auth()	Deactivates auth, removing all ACLs, tokens, and admins from the Pachyderm cluster and making all data publicly accessible.
deactivate_enterprise()	Deactivates enterprise.
delete_all()	Delete all repos, commits, files, pipelines, and jobs.
delete_all_identity()	Delete all identity service information.
delete_all_license()	Remove all clusters and deactivate the license service.
delete_all_pipelines()	Deletes all pipelines.
delete_all_repos()	Deletes all repos.
delete_all_transactions()	Deletes all transactions.
delete_branch(repo_name, branch_name[, force])	Deletes a branch, but leaves the commits themselves intact.
delete_cluster(id)	Delete a cluster registered with the license service.
delete_file(commit, path)	Deletes a file from an open commit.
delete_idp_connector(id)	Delete an IDP connector in the identity server.
delete_job(job_id, pipeline_name)	Deletes a subjob (job at the pipeline-level).
delete_oidc_client(id)	Delete an OIDC client in the identity server.
delete_pipeline(pipeline_name[, force, ...])	Deletes a pipeline.
delete_repo(repo_name[, force])	Deletes a repo and reclaims the storage space it was using.
delete_secret(secret_name)	Deletes a secret.
delete_transaction(transaction)	Deletes a transaction.
diff_file(new_commit, new_path[, ...])	Diffs two PFS files (file = commit + path in Pachyderm) and returns files that are different.
drop_commit(commit_id)	Drops an entire commit.
dump([filter, limit])	Gets a debug dump.
extract_auth_tokens()	This maps to an internal function that is only used for migration.
finish_commit(commit[, description, error, ...])	Ends the process of committing data to a repo and persists the commit.
finish_transaction(transaction)	Finishes a transaction.
fsck([fix])	Performs a file system consistency check on PFS, ensuring the correct provenance relationships are satisfied.
get_activation_code()	Returns the enterprise code used to activate Pachdyerm Enterprise in this cluster.
get_auth_configuration()	Gets the auth configuration.
get_enterprise_state()	Gets the current enterprise state of the cluster.
get_file(commit, path[, datum, URL, offset])	Gets a file from PFS.
get_file_tar(commit, path[, datum, URL, offset])	Gets a file from PFS.
get_groups()	Gets a list of groups this user belongs to.
get_identity_server_config()	Get the embedded identity server configuration.
get_idp_connector(id)	Get an IDP connector in the identity server.
get_job_logs(pipeline_name, job_id[, ...])	Gets logs for a job.
get_oidc_client(id)	Get an OIDC client in the identity server.
get_oidc_login()	Gets the OIDC login configuration.
get_pause_status()	Gets the pause status of the cluster.
get_pipeline_logs(pipeline_name[, ...])	Gets logs for a pipeline.
get_remote_version()	Gets version of Pachyderm server.
get_robot_token(robot[, ttl])	Gets a new auth token for a robot user.
get_role_binding(resource)	Returns the current set of role bindings to the resource specified.
get_roles_for_permission(permission)	Returns a list of all roles that have the specified permission.
get_users(group)	Gets users in a group.
glob_file(commit, pattern)	Lists files that match a glob pattern.
health_check()	Returns a health check indicating if the server can handle RPCs.
inspect_branch(repo_name, branch_name)	Inspects a branch.
inspect_cluster()	Inspects a cluster.
inspect_commit(commit[, commit_state])	Inspects a commit.
inspect_datum(pipeline_name, job_id, datum_id)	Inspects a datum.
inspect_file(commit, path[, datum])	Inspects a file.
inspect_job(job_id[, pipeline_name, wait, ...])	Inspects a job.
inspect_pipeline(pipeline_name[, history, ...])
inspect_repo(repo_name)	Inspects a repo.
inspect_secret(secret_name)	Inspects a secret.
inspect_transaction(transaction)	Inspects a transaction.
list_branch(repo_name[, reverse])	Lists the active branch objects in a repo.
list_clusters()	List clusters registered with the license service.
list_commit([repo_name, to_commit, ...])	Lists commits.
list_datum([pipeline_name, job_id, input])	Lists datums.
list_file(commit, path[, datum])	Lists the files in a directory.
list_idp_connectors()	List IDP connectors in the identity server.
list_job([pipeline_name, input_commit, ...])	Lists jobs.
list_oidc_clients()	List OIDC clients in the identity server.
list_pipeline([history, details, jqFilter])
list_repo([type])	Lists all repos in PFS.
list_secret()	Lists secrets.
list_transaction()	Lists unfinished transactions.
list_user_clusters()	Lists all clusters available to user.
modify_file_client(commit)	A context manager that gives a ModifyFileClient.
modify_members(group[, add, remove])	Adds and/or removes members of a group.
modify_role_binding(resource, principal[, roles])	Sets the roles for a given principal on a resource.
mount(mount_dir[, repos])	Mounts Pachyderm repos locally.
new_from_config(config_file)	Creates a Pachyderm client from a config file-like object.
new_from_pachd_address(pachd_address[, ...])	Creates a Pachyderm client from a given pachd address.
new_in_cluster([auth_token, transaction_id])	Creates a Pachyderm client that operates within a Pachyderm cluster.
path_exists(commit, path)	Checks whether the path exists in the specified commit, agnostic to whether path is a file or a directory.
pause_enterprise()	Pauses the cluster.
profile_cpu(duration[, filter])	Gets a CPU profile.
put_file_bytes(commit, path, value[, datum, ...])	Uploads a PFS file from a file-like object, bytestring, or iterator of bytestrings.
put_file_url(commit, path, url[, recursive, ...])	Uploads a PFS file using the content found at a URL.
restart_datum(pipeline_name, job_id[, ...])	Restarts a datum.
restore_auth_token([token])	This maps to an internal function that is only used for migration.
revoke_auth_token(token)	Revokes an auth token.
run_cron(pipeline_name)	Triggers a cron pipeline to run now.
set_auth_configuration(configuration)	Sets the auth configuration.
set_groups_for_user(username, groups)	Sets the group membership for a user.
set_identity_server_config(config)	Configure the embedded identity server.
squash_commit(commit_id)	Squashes a commit into its parent.
start_commit(repo_name, branch[, parent, ...])	Begins the process of committing data to a repo.
start_pipeline(pipeline_name)	Starts a pipeline.
start_transaction()	Starts a transaction.
stop_job(job_id, pipeline_name[, reason])	Stops a subjob (job at the pipeline-level).
stop_pipeline(pipeline_name)	Stops a pipeline.
subscribe_commit(repo_name, branch[, ...])	Returns all commits on the branch and then listens for new commits that are created.
transaction()	A context manager for running operations within a transaction.
unmount([mount_dir, all_mounts])	Unmounts mounted local filesystems with Pachyderm repos.
unpause_enterprise()	Unpauses the cluster.
update_cluster(id, address[, user_address, ...])	Update a cluster registered with the license service.
update_idp_connector(connector)	Update an IDP connector in the identity server.
update_oidc_client(client)	Update an OIDC client in the identity server.
wait_commit(commit)	Waits for the specified commit to finish.
walk_file(commit, path[, datum])	Walks over all descendant files in a directory.
who_am_i()	Returns info about the user tied to this Client.