Skip to content

Commit 24acc83

Browse files
committed
addressing the format issues
1 parent 3438b50 commit 24acc83

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

docs/utility-guides/Oracle.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,12 @@ The docstrings also specify when arguments are optional, and what the default va
3737

3838
**The main methods provided by OracleDB are:**
3939

40-
-connect_to_db(self)-Connects to the Oracle database using credentials from environment variables.
41-
-disconnect_from_db(self, conn)-Closes the provided Oracle database connection.
42-
-execute_query(self, query, params=None)-Executes a SQL query with optional parameters and returns the results as a pandas DataFrame.
43-
-execute_stored_procedure(self, procedure_name, params=None)-Executes a named stored procedure with optional parameters.
44-
-exec_bcss_timed_events(self, nhs_number_df)-Runs the bcss_timed_events stored procedure for each NHS number provided in a DataFrame.
45-
-get_subject_id_from_nhs_number(self, nhs_number)-Retrieves the subject_screening_id for a given NHS number.
40+
- **connect_to_db(self)**: Connects to the Oracle database using credentials from environment variables.
41+
- **disconnect_from_db(self, conn)**: Closes the provided Oracle database connection.
42+
- **execute_query(self, query, params=None)**: Executes a SQL query with optional parameters and returns the results as a pandas DataFrame.
43+
- **execute_stored_procedure(self, procedure_name, params=None)**: Executes a named stored procedure with optional parameters.
44+
- **exec_bcss_timed_events(self, nhs_number_df)**: Runs the `bcss_timed_events` stored procedure for each NHS number provided in a DataFrame.
45+
- **get_subject_id_from_nhs_number(self, nhs_number)**: Retrieves the `subject_screening_id` for a given NHS number.
4646

4747
For full implementation details, see utils/oracle/oracle.py.
4848

@@ -71,6 +71,8 @@ def run_stored_procedure() -> None:
7171
OracleDB().execute_stored_procedure("bcss_timed_events")
7272
```
7373

74+
---
75+
7476
## Oracle Specific Functions
7577

7678
This contains SQL queries that can be used to run tests.<br>
@@ -80,11 +82,11 @@ Common values are placed in the `SqlQueryValues` class to avoid repeating the sa
8082

8183
## How to Add New Oracle-Specific Functions
8284

83-
-Define a new function in utils/oracle/oracle_specific_functions.py.
84-
-Create your SQL query, parameterizing as needed.
85-
-Call OracleDB().execute_query(query, params) to run the query.
86-
-Return the result as a pandas DataFrame.
87-
-Document the function with a clear docstring.
85+
- Define a new function in `utils/oracle/oracle_specific_functions.py`.
86+
- Create your SQL query, parameterizing as needed.
87+
- Call `OracleDB().execute_query(query, params)` to run the query.
88+
- Return the result as a pandas DataFrame.
89+
- Document the function with a clear docstring.
8890

8991
## Example Usage
9092

0 commit comments

Comments
 (0)