From 23ad0f91c5f8200edf684923bc59b9e25f243657 Mon Sep 17 00:00:00 2001 From: Travis Elkins Date: Fri, 30 Oct 2020 11:35:13 +0100 Subject: [PATCH] Added documentation on database connection... Updated documentation to reflect recent changes that allow one to specify the database connection that should be used...where to find the `dag_edges` table. --- README.md | 42 ++++++++++++++++++++++++++++-------------- 1 file changed, 28 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 7b67913..86eecfe 100644 --- a/README.md +++ b/README.md @@ -63,22 +63,36 @@ This is the contents of the published config file: ```php return [ - /* - |-------------------------------------------------------------------------- - | Max Hops - |-------------------------------------------------------------------------- - | - | This value represents the maximum number of hops that are allowed where - | hops "[i]ndicates how many vertex hops are necessary for the path; it is - | zero for direct edges". - | - | The more hops that are allowed (and used), then the more DAG edges will - | be created. This will have an increasing impact on performance, space, - | and memory. Whether or not it's negligible, noticeable, or impactful - | depends on a variety of factors. - */ + /** + *------------------------------------------------------------------------- + * Max Hops + *------------------------------------------------------------------------- + * + * This value represents the maximum number of hops that are allowed where + * hops "[i]ndicates how many vertex hops are necessary for the path; it is + * zero for direct edges". + * + * The more hops that are allowed (and used), then the more DAG edges will + * be created. This will have an increasing impact on performance, space, + * and memory. Whether or not it's negligible, noticeable, or impactful + * depends on a variety of factors. + */ 'max_hops' => 5, + + /** + *------------------------------------------------------------------------- + * Default Database Connection Name + *------------------------------------------------------------------------- + * + * This is the name of the database connection where the dag_edges table + * can be found. + * + * Set to `null` to use the default connection. + */ + + 'default_database_connection_name' => null, + ]; ```